Skip to content

Conversation

jaimergp
Copy link
Contributor

@jaimergp jaimergp commented Nov 23, 2021

Here I will collect the deep dive guides for different aspects of conda:

  • CLI
  • conda install from top to bottom
  • Context object
  • Activation (?)
  • Solvers
  • Solver state specification

@anaconda-issue-bot anaconda-issue-bot added the cla-signed [bot] added once the contributor has signed the CLA label Nov 23, 2021
@jezdez jezdez added the type::documentation request for improved documentation label Nov 24, 2021
@jezdez jezdez changed the title [Docs] Start deep dive docs Start deep dive docs Nov 24, 2021
@jaimergp jaimergp mentioned this pull request Nov 25, 2021
3 tasks
@jezdez
Copy link
Member

jezdez commented Jan 10, 2022

@kathatherine This is one of the ongoing work on the docs from the community side.

@kathatherine
Copy link
Contributor

@jezdez Excellent. This'll help me not duplicate work. I'll make sure I'm following this.

@jaimergp
Copy link
Contributor Author

Let me know if anything needs clarification @kathatherine! Also you will see English is not my native language so feel free to edit as you see fit :)

jaimergp and others added 3 commits February 21, 2022 15:59
Co-authored-by: Bianca Henderson <beeankha@gmail.com>
Co-authored-by: beeankha <beeankha@users.noreply.github.com>
Copy link
Member

@jezdez jezdez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jaimergp There are a few TODOs left that would show up in the docs, what should we do about them?

Comment on lines 406 to 408
```{admonition} Anatomy of the conda caches
TODO
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also a TODO?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I commented this out for now, not crucial to understanding the whole thing.


# Processing specs for `conda remove`

<!-- WIP -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got some empty header sections here as well.

> TL;DR: when working with `MatchSpec` objects,
> - to minimize the version change, set `MatchSpec(name=name, target=prec.dist_str())`
> - to freeze the package, set all the components of `MatchSpec` individually
* if the `spec` object does not have an adjective, it should be assumed it's being added to the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something seems to be going wrong with the Markdown formatting here. I'm not sure if it affects the output. Maybe add a line beneath the blockquote?

@jezdez jezdez modified the milestones: 4.12.0, Release TBD Feb 28, 2022
@jezdez
Copy link
Member

jezdez commented Feb 28, 2022

I think we shouldn't block the 4.12.0 release on this work, if we get it done super, but not a big deal.

@kenodegard kenodegard added in-progress issue is actively being worked on and removed backlog issue has been triaged but has not been earmarked for any upcoming release labels Mar 3, 2022
@jaimergp
Copy link
Contributor Author

@jezdez Pushed latest changes with syntax fixes and the figures from the Anaconda presentations. I see that there's now a RTD preview job, so we can review there to make sure nothing is out of place.

Copy link
Member

@jezdez jezdez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jaimergp Thank you Jaime for the updates!

@jezdez
Copy link
Member

jezdez commented May 17, 2022

@kathatherine Could you do another pass over Jaime's recent changes?

Copy link
Contributor

@kathatherine kathatherine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two very minor things, but all else looks good to me!

jezdez and others added 2 commits May 18, 2022 09:59
Co-authored-by: Katherine Kinnaman <kkinnaman@anaconda.com>
Co-authored-by: Katherine Kinnaman <kkinnaman@anaconda.com>
@jezdez
Copy link
Member

jezdez commented May 18, 2022

pre-commit.ci autofix

@jezdez jezdez merged commit b5992a8 into master May 18, 2022
@jezdez jezdez deleted the deep-dive-docs branch May 18, 2022 08:45
@kenodegard kenodegard modified the milestones: Release TBD, 4.13.0 May 20, 2022
@github-actions github-actions bot added the locked [bot] locked due to inactivity label May 21, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed [bot] added once the contributor has signed the CLA in-progress issue is actively being worked on locked [bot] locked due to inactivity sync::anaconda sync internally with Anaconda, Inc. ticket tracker type::documentation request for improved documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants