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

Update Bundled App Installation Instructions #74

Merged
merged 18 commits into from
Jul 25, 2024

Conversation

jaimergp
Copy link
Contributor

@jaimergp jaimergp commented Dec 15, 2022

Description

Add detailed installation instructions for the new conda-based bundled app, updated with screenshots from 0.5.0+.

References

Closes #67

This PR brings napari/napari#4383 over to napari/docs. It's not a perfect port, and I had to edit some patches, but it keeps most of the original history.

Inspired by napari/napari#5240 (comment), I followed these steps:

  1. Obtain the commit-by-commit patch from the original PR:
$ cd ~/devel/napari/napari
$ gh pr checkout 4383
$ gh pr diff --patch > ~/tmp/napari-4383.patch
  1. Apply patch interactively on napari/docs:
$ cd ~/devel/napari/docs
# Create new branch from up-to-date main
$ git checkout main
$ git pull upstream main
$ git checkout -b bring-napari-4383
# Apply patch
$ git am ~/tmp/napari-4383.patch

Sadly, the naive git am command with no flags didn't work, so I had to do it "interactively" with -i --rejected, which iteratively creates *.rej files with the rejected chunks of each patch:

$ git am -i --rejected ~/tmp/napari-4383.patch
# analyze rejection and modify target file; then:
$ git am -i --rejected --continue
# rinse and repeat til you are done

dgmccart and others added 4 commits December 15, 2022 13:44
Adding images for the new bundled app installation instructions
Updating the bundled app installation instructions for MacOS, Windows, and Linux based on the new instructions for the latest bundled app release
Adding in @jaimergp suggestions and some other copy changes to the bundle installation guide
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 15, 2022
Keep existing installation.md, and rename the split installation_bundle.md as installation_bundle_conda.md. The existing installation.md covers the Briefcase installers.
@jaimergp
Copy link
Contributor Author

Loving the <kbd> default style!

image

@psobolewskiPhD
Copy link
Member

Gentle reminder about this one @jaimergp Pretty high-value contribution!!
❤️

@psobolewskiPhD psobolewskiPhD added this to the 0.5.0 milestone Feb 28, 2024
@jaimergp
Copy link
Contributor Author

jaimergp commented Mar 21, 2024

I don't remember what was blocking this, but I think I recall it was something about conveying the right kind of messaging in the website. Are we ok to publish this now? @psobolewskiPhD

Assuming we are, I think it would just need to update the screenshots so it shows 0.5.0 instead of 0.4.18-ish, and maybe polish some text here and there.

Are we still pushing images directly in the git repo or is there another mechanism I should be aware of?

@psobolewskiPhD
Copy link
Member

@jaimergp I think the bundle was considered experimental? but now it's pretty stable, right?
Anyhow, I think it's definitely something we want in the docs.
Nothing has changed with images, just commit and push.

@melissawm
Copy link
Member

Hi all! Is there anything I can do to help push this forward? Cheers! 😄

@jni jni modified the milestones: 0.5.0, 0.5.1 Jul 11, 2024
@jaimergp
Copy link
Contributor Author

Now that we have 0.5.x out, we can take the screenshots and update the text.

@jaimergp
Copy link
Contributor Author

@melissawm - do you happen to have a Linux (VM or not) machine for x64? I can only virtualize ARM 😬

@melissawm
Copy link
Member

@jaimergp yes I do, happy to help!

@jaimergp
Copy link
Contributor Author

Excellent, we'd just need to update the screenshots docs/tutorials/assets/tutorials/installation/bundle_{28..35}.png with the most recent Linux SH installer at https://github.com/napari/napari/releases/tag/v0.5.0.

Copy link
Member

@melissawm melissawm left a comment

Choose a reason for hiding this comment

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

Instructions work fine on Manjaro - do you need anything else? Updated screenshots of the viewer? For the terminal screenshots, I think the Ubuntu ones are more common tbh.

EDIT: Got it, will push to this PR in a few mins.

docs/tutorials/fundamentals/installation_bundle_conda.md Outdated Show resolved Hide resolved
@jaimergp
Copy link
Contributor Author

Updated screenshots of the viewer?

It's mostly about the version string in the screenshots. Having 0.5.0 looks cleaner than a dev version of 0.4.17 😬

I need to update the text too. I'll take a look at your suggestion, thanks!

@melissawm
Copy link
Member

Let me know if you need something different!

@jaimergp
Copy link
Contributor Author

Looks amazing, thanks @melissawm!

@jaimergp jaimergp changed the title [WIP] Updating napari's python and Bundled App Installation Instructions (continued) Update Bundled App Installation Instructions Jul 16, 2024
@jaimergp jaimergp marked this pull request as ready for review July 16, 2024 18:41
Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment

Choose a reason for hiding this comment

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

This looks super!
Could we get it better integrated with the installation guide?
https://output.circle-artifacts.com/output/job/a8a5e740-214a-47ab-9c56-fed5228432a4/artifacts/0/docs/docs/_build/html/tutorials/fundamentals/installation.html#install-as-a-bundled-app
I think this should be all but dropped and just replaced with a link to the new guide?

@jni
Copy link
Member

jni commented Jul 24, 2024

@jaimergp we just discussed this at community meeting. At a minimum before merge we would like to add a link to this new guide in this page (source link). We are planning to release later today, so if you have a chance to add a small link 🙏 that would be great, otherwise, let us know and we can push directly.

@jni
Copy link
Member

jni commented Jul 24, 2024

it looks good to me, thanks @jaimergp — I'm just gonna give @psobolewskiPhD a chance to have another look at it, but will just merge in the morning if he doesn't get a chance.

@jni jni dismissed psobolewskiPhD’s stale review July 25, 2024 00:52

comments were address by adding link in b322829

@jni jni merged commit b7527cd into napari:main Jul 25, 2024
9 checks passed
@psobolewskiPhD
Copy link
Member

psobolewskiPhD commented Jul 25, 2024

Sorry I dropped the ball on this -- long day 😞

@jni
Copy link
Member

jni commented Jul 25, 2024

all is well @psobolewskiPhD, I just hope I didn't offend you with

Screenshot 2024-07-25 at 1 02 20 PM

😂 🙏

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
6 participants