Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

DOC: Update environment documentation #748

Merged
merged 2 commits into from
Jun 22, 2022
Merged

DOC: Update environment documentation #748

merged 2 commits into from
Jun 22, 2022

Conversation

peterhessey
Copy link
Contributor

Closes #743

Update documentation for setting up environments to include instructions for MacOS users and remove conflicting / confusing instructions.

@peterhessey peterhessey force-pushed the phessey/add-macOS-env-instructions branch from e6977e7 to 3384cd8 Compare June 21, 2022 11:55
ant0nsc
ant0nsc approved these changes Jun 21, 2022
View reviewed changes
Copy link
Contributor

@ant0nsc ant0nsc left a comment

Choose a reason for hiding this comment

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

Looks good, reads very clearly now.
I am still wondering if the duplication of instructions for the "happy path to quick success" (limited to Ubuntu only, like we had in Readme before, is worth the duplication effort. Maybe get a second opinion from @fepegar?

docs/environment.md Outdated Show resolved Hide resolved
docs/environment.md Show resolved Hide resolved
docs/environment.md Outdated Show resolved Hide resolved
docs/environment.md Outdated Show resolved Hide resolved
docs/environment.md Show resolved Hide resolved
@fepegar
Copy link
Contributor

fepegar commented Jun 21, 2022

I didn't know the suggestions feature ❤️ It's great! We should share it with the team.

I'll take a look now.

fepegar
fepegar suggested changes Jun 21, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/contributing.md Outdated Show resolved Hide resolved
docs/contributing.md Outdated Show resolved Hide resolved
docs/environment.md Show resolved Hide resolved
@fepegar
Copy link
Contributor

fepegar commented Jun 21, 2022

Looks good, reads very clearly now. I am still wondering if the duplication of instructions for the "happy path to quick success" (limited to Ubuntu only, like we had in Readme before, is worth the duplication effort. Maybe get a second opinion from @fepegar?

I think it would be nice to have a quick setup + hello world run in the README, yes. It can assume some things (Linux, conda installed) and refer to the docs for further info. The structure would be clearer (at least to me) if we had the docs on RTD (#706, #720).

@peterhessey
Copy link
Contributor Author

Noted, thanks guys. Will add a clear-cut quick setup back into the README!

@peterhessey peterhessey requested a review from fepegar June 21, 2022 14:41
@peterhessey peterhessey force-pushed the phessey/add-macOS-env-instructions branch from e742e11 to 418d35b Compare June 21, 2022 14:43
fepegar
fepegar approved these changes Jun 21, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
@peterhessey peterhessey force-pushed the phessey/add-macOS-env-instructions branch from 418d35b to 7a1042e Compare June 21, 2022 15:01
@peterhessey peterhessey force-pushed the phessey/add-macOS-env-instructions branch from 7a1042e to fc743ab Compare June 22, 2022 10:31
@peterhessey peterhessey enabled auto-merge (squash) June 22, 2022 10:32
@peterhessey peterhessey merged commit 69a5e8c into main Jun 22, 2022
@peterhessey peterhessey deleted the phessey/add-macOS-env-instructions branch June 22, 2022 10:57
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ant0nsc ant0nsc ant0nsc approved these changes

@fepegar fepegar fepegar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

No Environment Instructions for MacOS users
3 participants
@peterhessey @fepegar @ant0nsc