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

mac-and-windows-install-docs #1586

Merged
merged 6 commits into from
Sep 18, 2024
Merged

Conversation

annacasto
Copy link
Contributor

@annacasto annacasto commented Aug 23, 2024

Describe your changes
We are creating separate installation instructions for mac and windows to clarify the install instructions. We also added a Scribe follow-along tutorial.

Type of update
Is this a:

  • Update to documentation

Associated issues
None

Additional context

For the reviewer
See this page for instructions on how to review the pull request.

  • PR functionality reviewed in a Jupyter Notebook
  • All tests pass
  • Test coverage remains 100%
  • Documentation tested
  • New documentation pages added to plantcv/mkdocs.yml
  • Changes to function input/output signatures added to updating.md
  • Code reviewed
  • PR approved

@annacasto annacasto self-assigned this Aug 23, 2024
Copy link

deepsource-io bot commented Aug 23, 2024

Here's the code health analysis summary for commits 0f0a7f7..9e70543. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython✅ SuccessView Check ↗
DeepSource Test coverage LogoTest coverage✅ SuccessView Check ↗

Code Coverage Report

MetricAggregatePython
Branch Coverage100%100%
Composite Coverage100%100%
Line Coverage100%100%

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@annacasto annacasto added work in progress Mark work in progress documentation Documentation issues or features labels Aug 23, 2024
@annacasto
Copy link
Contributor Author

We actually ended up decided to keep the installation instructions as one page instead of having separate mac and windows install instruction. I have still updated instructions to be a little more clear for Windows users

@annacasto annacasto added ready to review and removed work in progress Mark work in progress labels Aug 23, 2024
@zeeuqsze
Copy link
Contributor

zeeuqsze commented Sep 6, 2024

I added a comment to the Git for Windows step and also fixed a couple of typos.

@annacasto
Copy link
Contributor Author

I have removed steps that are duplicated instructions from Miniconda install instructions. This will help us not have to update the instructions if Miniconda changes their install instructions.

@zeeuqsze I think including Git Bash for Windows as an option is ok. They have clear install instructions and if it works (which Keely will test) there are clear instructions for adding conda to their PATH.

@nfahlgren nfahlgren added this to the PlantCV v4.6 milestone Sep 17, 2024
@nfahlgren
Copy link
Member

@annacasto I reorganized the installation page a bit and @zeeuqsze I added the Jupyter Lab Desktop guide. See what you think

@annacasto
Copy link
Contributor Author

looks good to me!

@nfahlgren nfahlgren merged commit 1429294 into main Sep 18, 2024
5 checks passed
@nfahlgren nfahlgren deleted the installation-documentation-update branch September 18, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation issues or features ready to review
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants