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.

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

Update installation docs to remove briefcase bundle mentions #147

Merged
merged 15 commits into from May 30, 2023
Merged

Update installation docs to remove briefcase bundle mentions #147

merged 15 commits into from May 30, 2023

Conversation

jaimergp
Copy link
Contributor

@jaimergp jaimergp commented May 4, 2023 •
edited

Description

  • Fixes or improves existing content
  • Adds new content page(s)
  • Fixes or improves workflow, documentation build or deployment
  • Removes outdated documentation

References

Depends on napari/napari#5804

Final checklist:

  • My PR is the minimum possible work for the desired functionality
  • I have commented my code, particularly in hard-to-understand areas
  • I have added alt text to new images included in this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 4, 2023
@Czaki
Copy link
Contributor

Czaki commented May 4, 2023

I have merged #124. It may be used here/

@jaimergp jaimergp changed the title remove briefcase mentions (WIP) remove briefcase mentions May 19, 2023
@jaimergp jaimergp marked this pull request as ready for review May 19, 2023 09:54
@jaimergp
Copy link
Contributor Author

This is ready for review but we still need napari/napari#5804 merged first.

@psobolewskiPhD
Copy link
Member

@jaimergp
Should we get #74 over the line as well in parallel to this one?
In this one you already have a warning about the bundle being somewhat experimental...

@jaimergp
Copy link
Contributor Author

@psobolewskiPhD we had a little discussion over that PR in the packaging meeting and the consensus seemed to be that we will wait a little bit longer on that one until we clarify how this is going to be maintained in terms of teams and responsibilities.

@psobolewskiPhD
Copy link
Member

Hmm, OK.
Priority needs to be removing the broken bundle.
But we should prioritize re-documenting the new bundle, even if we need to make it clearly as experimental. This way we can get more feedback to deal with issues/bugs.

@psobolewskiPhD psobolewskiPhD mentioned this pull request May 24, 2023
Merged
5 tasks
Czaki added a commit to napari/napari that referenced this pull request May 24, 2023
@jaimergp @pre-commit-ci @Czaki
[MAINT, packaging] Remove support for briefcase installers (#5804)
d4ba4a0 
# Fixes/Closes
Closes #5506

# Description

The Briefcase bundles have not been working for a while (at least in
some platforms), nobody is testing them either, and our development
efforts are mostly directed to the `constructor` installers.
In this PR, they are removed to [avoid CI
waste](#5660) and permit deleting
some strange code paths for Briefcase workarounds.

# References

## Type of change
- [X] Removes / deprecates code

# How has this been tested?
<!-- Please describe the tests that you ran to verify your changes. -->
- [x] No CI jobs for Briefcase
- [x] Tests pass without the extra Briefcase workarounds

## Final checklist:
- [X] My PR is the minimum possible work for the desired functionality
- [x] I have made corresponding changes to the documentation:
napari/docs#147

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
@Czaki
Copy link
Contributor

Czaki commented May 24, 2023

@napari/copy This also needs to be checked.

@psobolewskiPhD @kne42
typo fix by @kne42
a025b6a 
Co-authored-by: Kira Evans <contact@kne42.me>
psobolewskiPhD
psobolewskiPhD requested changes May 24, 2023
View reviewed changes
Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment •
edited

Choose a reason for hiding this comment

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

I'd prefer the warning for the bundle being in dev being at the top.
Also I'd like the direct links to work, instead of just directing to the assets.
Can add a substitution if needed to make it simpler.
(Copy is fine IMO)

docs/tutorials/fundamentals/installation.md Show resolved Hide resolved
docs/tutorials/fundamentals/installation.md Outdated Show resolved Hide resolved
docs/tutorials/fundamentals/quick_start.md Outdated Show resolved Hide resolved
psobolewskiPhD
psobolewskiPhD approved these changes May 25, 2023
View reviewed changes
Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment •
edited

Choose a reason for hiding this comment

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

@jaimergp
Looks good now, but I noticed a tiny typo in unrelated part of the installation.md:
new line 247:

    - include the output of `napari -info`

should be:

    - include the output of `napari --info``

(two dashes)
I can't suggest it, can you make that change? else it's another PR...

@psobolewskiPhD psobolewskiPhD changed the title remove briefcase mentions Update installation docs to remove briefcase bundle mentions May 30, 2023
@psobolewskiPhD psobolewskiPhD merged commit 1227c9f into napari:main May 30, 2023
5 checks passed
Czaki added a commit to napari/napari that referenced this pull request Jun 19, 2023
@jaimergp @pre-commit-ci @Czaki
Remove support for briefcase installers (#5804)
66ba08d 
Closes #5506

The Briefcase bundles have not been working for a while (at least in
some platforms), nobody is testing them either, and our development
efforts are mostly directed to the `constructor` installers.
In this PR, they are removed to [avoid CI
waste](#5660) and permit deleting
some strange code paths for Briefcase workarounds.

- [X] Removes / deprecates code

<!-- Please describe the tests that you ran to verify your changes. -->
- [x] No CI jobs for Briefcase
- [x] Tests pass without the extra Briefcase workarounds

- [X] My PR is the minimum possible work for the desired functionality
- [x] I have made corresponding changes to the documentation:
napari/docs#147

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
Czaki added a commit to napari/napari that referenced this pull request Jun 21, 2023
@jaimergp @pre-commit-ci @Czaki
Remove support for briefcase installers (#5804)
412d780 
Closes #5506

The Briefcase bundles have not been working for a while (at least in
some platforms), nobody is testing them either, and our development
efforts are mostly directed to the `constructor` installers.
In this PR, they are removed to [avoid CI
waste](#5660) and permit deleting
some strange code paths for Briefcase workarounds.

- [X] Removes / deprecates code

<!-- Please describe the tests that you ran to verify your changes. -->
- [x] No CI jobs for Briefcase
- [x] Tests pass without the extra Briefcase workarounds

- [X] My PR is the minimum possible work for the desired functionality
- [x] I have made corresponding changes to the documentation:
napari/docs#147

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
Czaki added a commit to napari/napari that referenced this pull request Jun 21, 2023
@jaimergp @pre-commit-ci @Czaki
Remove support for briefcase installers (#5804)
d72757f 
Closes #5506

The Briefcase bundles have not been working for a while (at least in
some platforms), nobody is testing them either, and our development
efforts are mostly directed to the `constructor` installers.
In this PR, they are removed to [avoid CI
waste](#5660) and permit deleting
some strange code paths for Briefcase workarounds.

- [X] Removes / deprecates code

<!-- Please describe the tests that you ran to verify your changes. -->
- [x] No CI jobs for Briefcase
- [x] Tests pass without the extra Briefcase workarounds

- [X] My PR is the minimum possible work for the desired functionality
- [x] I have made corresponding changes to the documentation:
napari/docs#147

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
Czaki added a commit to napari/napari that referenced this pull request Jun 21, 2023
@jaimergp @pre-commit-ci @Czaki
Remove support for briefcase installers (#5804)
cea3e10 
Closes #5506

The Briefcase bundles have not been working for a while (at least in
some platforms), nobody is testing them either, and our development
efforts are mostly directed to the `constructor` installers.
In this PR, they are removed to [avoid CI
waste](#5660) and permit deleting
some strange code paths for Briefcase workarounds.

- [X] Removes / deprecates code

<!-- Please describe the tests that you ran to verify your changes. -->
- [x] No CI jobs for Briefcase
- [x] Tests pass without the extra Briefcase workarounds

- [X] My PR is the minimum possible work for the desired functionality
- [x] I have made corresponding changes to the documentation:
napari/docs#147

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
@psobolewskiPhD psobolewskiPhD added this to the 0.4.18 milestone Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kne42 kne42 kne42 left review comments

@Czaki Czaki Czaki approved these changes

@psobolewskiPhD psobolewskiPhD psobolewskiPhD approved these changes

Assignees

@jaimergp jaimergp

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.4.18
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@jaimergp @Czaki @psobolewskiPhD @kne42