Skip to content
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

Merged
merged 4 commits into from
Nov 13, 2024
Merged

feat: default env and container docs #79

merged 4 commits into from
Nov 13, 2024

Conversation

zmitchell
Copy link
Contributor

No description provided.

@floxbot floxbot added the documentation Improvements or additions to documentation label Nov 13, 2024
Copy link

Copy link

@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.

@zmitchell zmitchell merged commit 72f62fb into main Nov 13, 2024
5 checks passed
Copy link
Contributor

@brendaneamon brendaneamon left a 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,
Copy link
Contributor

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:
Copy link
Contributor

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.

Suggested change
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.
Copy link
Contributor

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!

Suggested change
- 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
Copy link
Contributor

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?

Suggested change
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

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.

5 participants