-
Notifications
You must be signed in to change notification settings - Fork 1
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
feat: default env and container docs #79
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✨
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent work 🏆
My comments are all grammatical or stylistic nitpicks, so please feel free to ignore.
# Flox vs. container workflows | ||
|
||
Containers are everywhere these days. | ||
They're the de-facto deployment method in the industry, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick: I'd suggest that de facto as a Latin phrase doesn't really need a hyphen; maybe go with italics if you want to be pretentious. Otherwise, just "de facto" will do fine.
## Add packages | ||
|
||
Now let's install some packages. | ||
In a typical project there's usually different subsets of packages: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick: There's a subject–verb agreement issue here, though the tone is conversational so it may not matter.
In a typical project there's usually different subsets of packages: | |
In a typical project there are usually different subsets of packages: |
In a typical project there's usually different subsets of packages: | ||
|
||
- Packages you don't care about too much, so the latest version will suffice. | ||
- Packages whose versions you want pinned to a recent version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick: This is a stylistic quibble, but I'd use "of which" instead of "whose" here given that we're not talking about persons. That may come off sounding a bit stodgy though, and I doubt anyone will misunderstand "whose." Your call on whether or not to change it!
- Packages whose versions you want pinned to a recent version. | |
- Packages the versions of which you want pinned to a recent version. |
``` | ||
|
||
You may need to authenticate with FloxHub first, | ||
but once that completes you're now able to share this environment with another |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick: When used as a verb, "complete" needs to be transitive. How about this?
but once that completes you're now able to share this environment with another | |
but when that's done, you're now able to share this environment with another |
No description provided.