Skip to content

docs: convert managed env back to path env with pull --copy #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

ghudgins
Copy link
Contributor

No description provided.

@floxbot floxbot added the documentation Improvements or additions to documentation label Sep 24, 2024
Copy link

Copy link
Contributor

@jennymahmoudi jennymahmoudi left a comment

Choose a reason for hiding this comment

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

Layout suggestion. Non-blocking

@@ -30,16 +30,17 @@ and are commonly used for self-contained projects or different subprojects
within a monorepo.
1. **Centrally managed environment**: An environment stored remotely on
Copy link
Contributor

Choose a reason for hiding this comment

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

I wouldn't change any of the words, but I think with this amount of text we need to break it up a bit. The way this page is set up, it's meant to be a high level overview of these env uses, so let's make it so the reader can quickly see the definition first, and the other info in related chunks, something like this:

1. **Path environment**: An environment stored in a local directory. 
  - This environment is self contained in the `.flox` directory and can be
reproduced by sharing the directory in version control or some other file
sharing mechanism.
  - Path environments are created with [`flox init`][flox_init],
referred to with the `--dir/-d` option on most CLI commands,
and are commonly used for self-contained projects or different subprojects
within a monorepo.

2. **Centrally managed environment**: An environment stored remotely on
[FloxHub][floxhub_concept].

  - Centrally managed environments are created by running [`flox push`][flox_push]
on a path environment. You can connect a new project directory with an existing centrally managed environment with [`flox pull ...`][flox_pull] or
you can activate the environment directly with [`flox activate --remote ...`][flox_activate] for
instant use.
  - Centrally managed environments enable multiple projects or systems to consume a
shared environment that is versioned with [generations][generation_concept].
They are commonly used as base environments for projects of similar tech stacks,
for reproducing issues on specific systems, or to quickly share tools.
  - To disconnect a centrally managed environment from FloxHub, run [`flox pull --copy`][flox_pull] instead of `flox pull`.
This will turn the environment back into a path environment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thank you, i've applied your changes

Copy link

Copy link
Contributor

@jennymahmoudi jennymahmoudi left a comment

Choose a reason for hiding this comment

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

👍

@ghudgins ghudgins merged commit 3f5c956 into preview Sep 30, 2024
3 checks passed
@ghudgins ghudgins deleted the f/pull-copy-conversion branch September 30, 2024 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants