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

fix: minor edits to make dev docs a bit more clear #17382

Merged
merged 9 commits into from
Jan 15, 2025

Conversation

lwasser
Copy link
Contributor

@lwasser lwasser commented Jan 10, 2025

This also addresses #17374 . i ran into a bit of confusion setting up the dev environment. I thought I had to do it all using Docker but in the end I just discovered I can simply run make. I tried to make it clear to new contribs that they can skip the docker setup if they wish to contribute to the docs only!

@lwasser lwasser requested a review from a team as a code owner January 10, 2025 00:15
Copy link
Member

@di di left a comment

Choose a reason for hiding this comment

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

Thanks!

@di di enabled auto-merge (squash) January 10, 2025 18:12
Copy link
Member

@woodruffw woodruffw left a comment

Choose a reason for hiding this comment

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

Thanks a ton @lwasser!

@miketheman miketheman added documentation developer experience Anything that improves the experience for Warehouse devs labels Jan 14, 2025
Copy link
Member

@miketheman miketheman left a comment

Choose a reason for hiding this comment

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

Some nits inline, and lint needs to be addressed.

docs/dev/development/getting-started.rst Outdated Show resolved Hide resolved
docs/dev/development/getting-started.rst Outdated Show resolved Hide resolved
docs/dev/development/getting-started.rst Outdated Show resolved Hide resolved
docs/dev/development/getting-started.rst Outdated Show resolved Hide resolved
docs/dev/development/getting-started.rst Outdated Show resolved Hide resolved
auto-merge was automatically disabled January 14, 2025 23:08

Head branch was pushed to by a user without write access

lwasser and others added 6 commits January 14, 2025 16:37
Co-authored-by: Mike Fiedler <miketheman@gmail.com>
Co-authored-by: Mike Fiedler <miketheman@gmail.com>
Co-authored-by: Mike Fiedler <miketheman@gmail.com>
Co-authored-by: Mike Fiedler <miketheman@gmail.com>
Co-authored-by: Mike Fiedler <miketheman@gmail.com>
@di
Copy link
Member

di commented Jan 15, 2025

@lwasser I fixed the linting errors for you here since there isn't a way to do this automatically. (FWIW, my editor is configured to automatically strip trailing whitespace, you might want to do the same in your editor! I just added the backticks manually).

@di di requested a review from miketheman January 15, 2025 15:43
@lwasser
Copy link
Contributor Author

lwasser commented Jan 15, 2025

@lwasser I fixed the linting errors for you here since there isn't a way to do this automatically. (FWIW, my editor is configured to automatically strip trailing whitespace, you might want to do the same in your editor! I just added the backticks manually).

Ahhhh ok. thanks!! i'll look into adding that step in my editor! i'm so used to pre-commit doing it for me it never occurred to me to set something like that up!

@miketheman miketheman merged commit 7c2bf39 into pypi:main Jan 15, 2025
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer experience Anything that improves the experience for Warehouse devs documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants