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

Specified that the path is to the local folder in contributing documentation guide. #5191

Merged
merged 2 commits into from
Oct 12, 2022

Conversation

Nadalyn-CZI
Copy link
Contributor

Description

To clarify location of example docs. Local paths don't match the website paths. Wanted to make it clear we were talking about the local repository. No interface changes, just text.

Type of change

  • This change required a documentation update

References

N/A

How has this been tested?

N/A

Final checklist:

@DragaDoncila DragaDoncila changed the title Specified that the path is to the local folder. Specified that the path is to the local folder in contributing documentation guide. Oct 8, 2022
Copy link
Contributor

@DragaDoncila DragaDoncila left a comment

Choose a reason for hiding this comment

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

Thanks for the clarification @Nadalyn-CZI! And congrats on your first PR 🎉 . One of the core devs will merge this in the coming days.

@psobolewskiPhD
Copy link
Member

Nice catch!
I wonder if it's worth additionally clarifying that this is in the cloned repository?
Or even adding something like:
https://napari.org/stable/developers/contributing.html#setting-up-a-development-installation
at the top?
I can imagine someone feeling comfortable to contribute docs, but not code and not realizing they need to also have the repo cloned.

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.

Makes sense, thank you @Nadalyn-CZI - glad you made it!

@@ -19,7 +19,7 @@ If you'd like to contribute a brand new document to our usage section, it might
The napari team can also suggest what type of document would be best suited, and whether there are already
existing documents that could be expanded to include the content you think is lacking.

Examples of documents you might want to contribute are:
Go to your local napari folder to find examples of documents you might want to contribute. The paths are listed in parentheses below.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This description is still nonclear to me. In my opinion, it assumes that the person install napari from the repository, not pip or conda

Copy link
Contributor

Choose a reason for hiding this comment

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

@Czaki since this is part of the contributing documentation guide, I think that's a valid assumption in this case.

@jni jni merged commit c224ebd into napari:main Oct 12, 2022
@Czaki Czaki mentioned this pull request Jun 7, 2023
@Czaki Czaki added the triaged-0.4.18 To mark PR that is triaged in 0.4.18 release process label Jun 7, 2023
@Czaki Czaki added this to the 0.4.18 milestone Jun 7, 2023
Czaki pushed a commit that referenced this pull request Jun 16, 2023
Czaki pushed a commit that referenced this pull request Jun 17, 2023
Czaki pushed a commit that referenced this pull request Jun 18, 2023
Czaki pushed a commit that referenced this pull request Jun 19, 2023
Czaki pushed a commit that referenced this pull request Jun 21, 2023
Czaki pushed a commit that referenced this pull request Jun 21, 2023
Czaki pushed a commit that referenced this pull request Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation triaged-0.4.18 To mark PR that is triaged in 0.4.18 release process
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants