Skip to content

📝 DOC: Improve Installation Instructions #567

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 17 commits into from
Mar 23, 2023
Merged

📝 DOC: Improve Installation Instructions #567

merged 17 commits into from
Mar 23, 2023

Conversation

@shaneahmed
Copy link
Member

@shaneahmed shaneahmed commented Mar 13, 2023 •
edited
Loading

@shaneahmed
📝 DOC: Improve installation instructions.
25bcb72 
- Improve installation instructions
@shaneahmed
📝 DOC: Reset heading levels.
b24008a 
- Reset heading levels
@shaneahmed
📝 DOC: Add instructions for Windows Anaconda.
87ba02c 
- Add instructions for Windows Anaconda.
@shaneahmed shaneahmed self-assigned this Mar 13, 2023
@shaneahmed shaneahmed added the documentation Improvements or additions to documentation label Mar 13, 2023
@codecov
Copy link

codecov bot commented Mar 13, 2023 •
edited
Loading

Codecov Report

Merging #567 (87ba02c) into develop (54b9e22) will not change coverage.
The diff coverage is n/a.

❗ Current head 87ba02c differs from pull request most recent head 32260c4. Consider uploading reports for the commit 32260c4 to get more accurate results

@@           Coverage Diff            @@
##           develop     #567   +/-   ##
========================================
  Coverage    99.51%   99.51%           
========================================
  Files           63       63           
  Lines         6591     6591           
  Branches      1077     1077           
========================================
  Hits          6559     6559           
  Misses          20       20           
  Partials        12       12

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@shaneahmed
[skip ci] 📝 DOC: Rearrange heading levels for docker.
89ee87b 
- Rearrange heading levels for docker.
@John-P John-P changed the title 📝 DOC: Improve installation instructions. 📝 DOC: Improve Installation Instructions Mar 13, 2023
John-P
John-P reviewed Mar 16, 2023
View reviewed changes
John-P
John-P reviewed Mar 16, 2023
View reviewed changes
John-P
John-P reviewed Mar 16, 2023
View reviewed changes
John-P
John-P reviewed Mar 16, 2023
View reviewed changes
John-P
John-P reviewed Mar 16, 2023
View reviewed changes
shaneahmed
shaneahmed commented Mar 16, 2023
View reviewed changes
@shaneahmed @John-P
[skip ci] 📝 DOC: Address review comments
6f77826 
- Address review comments

Co-authored-by: John Pocock <John-P@users.noreply.github.com>
shaneahmed
shaneahmed commented Mar 16, 2023
View reviewed changes
@shaneahmed shaneahmed requested a review from John-P March 16, 2023 10:40
shaneahmed
shaneahmed commented Mar 16, 2023
View reviewed changes
@shaneahmed
[skip ci] 📝 Add mamba instructions
187f815 
- Add mamba instructions
shaneahmed
shaneahmed commented Mar 16, 2023
View reviewed changes
John-P
John-P reviewed Mar 16, 2023
View reviewed changes
John-P
John-P reviewed Mar 16, 2023
View reviewed changes
John-P
John-P reviewed Mar 16, 2023
View reviewed changes
John-P
John-P reviewed Mar 16, 2023
View reviewed changes
shaneahmed
shaneahmed commented Mar 16, 2023
View reviewed changes
@shaneahmed @John-P
[skip ci] 📝 Fix typos
0489b84 
- Fix typos

Co-authored-by: John Pocock <John-P@users.noreply.github.com>
shaneahmed
shaneahmed commented Mar 16, 2023
View reviewed changes
@shaneahmed
[skip ci] 📝 Add instructions for docker installation
1ba4779 
- Add instructions for docker installation
shaneahmed
shaneahmed commented Mar 16, 2023
View reviewed changes
@John-P John-P self-requested a review March 16, 2023 12:54
@shaneahmed shaneahmed linked an issue Mar 17, 2023 that may be closed by this pull request
Add No Deps Pip Install Information To Documentation #559
Closed
@shaneahmed
[skip ci] 📝 Add headings to installation instructions.
599bf18 
- Add headings to installation instructions.
mostafajahanifar
mostafajahanifar approved these changes Mar 17, 2023
View reviewed changes
Copy link
Collaborator

@mostafajahanifar mostafajahanifar left a comment

Choose a reason for hiding this comment

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

Thank you very much, Shan. No installation is more clear and would not confuse (or stale users for Conda solving env) anymore.

I just suggest removing the "New" title because it seems redundant now.

shaneahmed
shaneahmed commented Mar 17, 2023
View reviewed changes
shaneahmed
shaneahmed commented Mar 17, 2023
View reviewed changes
@shaneahmed
[skip ci] 📝 Change New heading to Recommended
d221593 
- Change New heading to Recommended
shaneahmed
shaneahmed commented Mar 17, 2023
View reviewed changes
shaneahmed
shaneahmed commented Mar 17, 2023
View reviewed changes
shaneahmed
shaneahmed commented Mar 17, 2023
View reviewed changes
@shaneahmed
[skip ci] 📝 Update Windows instructions
32260c4 
- Update Windows instructions
@shaneahmed shaneahmed merged commit 2122f97 into develop Mar 23, 2023
@shaneahmed shaneahmed deleted the doc-improve-installation-instructions branch March 23, 2023 09:17
@shaneahmed shaneahmed added this to the Release v1.4.0 milestone Apr 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mostafajahanifar mostafajahanifar mostafajahanifar approved these changes

@DavidBAEpstein DavidBAEpstein Awaiting requested review from DavidBAEpstein

+1 more reviewer

@John-P John-P John-P approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@shaneahmed shaneahmed

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

Release v1.4.0

Development

Successfully merging this pull request may close these issues.

Add No Deps Pip Install Information To Documentation

4 participants

@shaneahmed @John-P @mostafajahanifar