docs: Add more documentation on environments
#790
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tdejager
requested changes
Feb 8, 2024
| @@ -452,7 +452,7 @@ The `environments` table allows you to define environments that are created usin | |||
| The environments table is defined using the following fields: | |||
|
|
|||
| - `features: Vec<Feature>`: The features that are included in the environment set, which is also the default field in the environments. | |||
| - `solve-group: String`: **[NOT IMPLEMENTED YET, ONLY DESERIALIZABLE]** The solve group is used to group environments together at the solve stage. | |||
| - `solve-group: String`: The solve group is used to group environments together at the solve stage. | |||
| This is useful for environments that need to have the same dependencies but might extend them with additional dependencies. | |||
| For instance when testing a production environment with additional test dependencies. | |||
There was a problem hiding this comment.
Maybe add a sentence that then versions of dependencies are used that work with production and test.
There was a problem hiding this comment.
Added extra info that explains it a little more
docs/environment.md
Outdated
| This location is **not** configurable as it is a specific design decision to keep the environments in the project directory. | ||
| This keeps your machine and your project clean and isolated from each other, and makes it easy to clean up after a project is done. | ||
|
|
||
| If you look at the `.pixi/envs` directory, you will see a directory for each environment, the `default` being the one that is used if you only have one environment. |
There was a problem hiding this comment.
Suggested change
| If you look at the `.pixi/envs` directory, you will see a directory for each environment, the `default` being the one that is used if you only have one environment. | |
| If you look at the `.pixi/envs` directory, you will see a directory for each environment, the `default` being the one that is used if you only have one environment, this will also be the case if you do not specify any environments. |
There was a problem hiding this comment.
Rewrote the line alittle
| . "/home/user/development/pixi/.pixi/envs/default/etc/conda/activate.d/libglib_activate.sh" | ||
| . "/home/user/development/pixi/.pixi/envs/default/etc/conda/activate.d/rust.sh" | ||
| ``` | ||
| It sets the `PATH` and some more environment variables. But more importantly it also runs activation scripts that are presented by the installed packages. |
There was a problem hiding this comment.
Do we have a reference as to what activation scripts are or maybe a link to one?
There was a problem hiding this comment.
Added a link to the glib script
docs/environment.md
Outdated
| - [Rip(PyPI) resolver blog](https://prefix.dev/blog/introducing_rip) | ||
|
|
||
| Pixi solves both the `conda` and `PyPI` dependencies, where the `PyPI` dependencies use the conda packages as a base, so you can be sure that the packages are compatible with each other. | ||
| These solvers are split between the `rattler` and `rip` library, these do the heavy lifting of the solving process. |
There was a problem hiding this comment.
Maybe link to resolvo as the solver, that is used in both projects?
There was a problem hiding this comment.
Yeah good one, extended this a with some more info
Co-authored-by: Tim de Jager <tdejager89@gmail.com>
Co-authored-by: Tim de Jager <tdejager89@gmail.com>
Co-authored-by: Tim de Jager <tdejager89@gmail.com>
Co-authored-by: Tim de Jager <tdejager89@gmail.com>
Co-authored-by: Tim de Jager <tdejager89@gmail.com>
Co-authored-by: Tim de Jager <tdejager89@gmail.com>
Co-authored-by: Tim de Jager <tdejager89@gmail.com>
Co-authored-by: Tim de Jager <tdejager89@gmail.com>
Co-authored-by: Tim de Jager <tdejager89@gmail.com>
baszalmstra
approved these changes
Feb 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixup missing CLI options and did a pass on explaining a pixi environment and how to use it.