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

doc: update screenshots for trusted publisher (and dev docs sync issue) #17374

Closed
lwasser opened this issue Jan 9, 2025 · 4 comments · Fixed by #17381
Closed

doc: update screenshots for trusted publisher (and dev docs sync issue) #17374

lwasser opened this issue Jan 9, 2025 · 4 comments · Fixed by #17381

Comments

@lwasser
Copy link
Contributor

lwasser commented Jan 9, 2025

Hi friends. This issue is being opened as it came up in this pr around screenshots i was using in a blog post!

Describe the bug
The images here use release as the environment name, but it sounds like PyPA prefers pypi.

Also, when I went to recreate it, the actual interface should look like this - there is now a project-name box at the top as well.

Image If you want to use these screenshots (or i can submit a pr) i can remove the 2025 from the second one. I had to do that because sampleProject already exists on pypi :) Image

Expected behavior
We want the screenshots to have PyPI as the environment name rather than release.

To Reproduce

My Platform
Additional context

More context & a suggestion if you are open to it. As a new contributor to warehouse 🚀 I'd be happy to submit a pr! But also, please know that your dev instructions are a bit off, and I'd love to update those, too (or at least help).

  • When I follow the new contributor path, I land on building documentation; this page says the docs are built with Sphinx and use make to build. But when I dug deeper into the readme for the docs, it is mkdocs and markdown instead! And, you need to have a docker setup (which I learned when following the link to installation instructions).

My suggestion, if you are open, is rather than having that information twice, have one source of truth and in the development guide, link to the readme, and installations instructions where things will most likely always be up to date. This might avoid things from becoming out of sync.

Please let me know if you'd be open to a pr to update the screenshots AND if you'd like me to update the dev docs as well to ensure information is correct across sections (unless I'm confused!!).

cc @webknjaz @woodruffw

@lwasser lwasser added bug 🐛 requires triaging maintainers need to do initial inspection of issue labels Jan 9, 2025
@lwasser lwasser changed the title doc: update screenshots for trusted publisher (and dev docs!) doc: update screenshots for trusted publisher (and dev docs sync issue) Jan 9, 2025
@webknjaz
Copy link
Member

webknjaz commented Jan 9, 2025

@lwasser thanks! I think nobody's going to oppose a PR :)

I originally updated a bunch of places in text but missed the pics.

@woodruffw
Copy link
Member

Yeah, please go ahead and open a PR! Thanks a ton @lwasser!

@woodruffw woodruffw added documentation and removed requires triaging maintainers need to do initial inspection of issue labels Jan 9, 2025
@di
Copy link
Member

di commented Jan 9, 2025

Also, when I went to recreate it, the actual interface should look like this - there is now a project-name box at the top as well.

Note that this is because the form you're looking at is the form to create a new project with a trusted publisher: https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/#github-actions

The form to add a trusted publisher to an existing project in the screenshot you linked to won't have the project name field, because the project already exists in that context.

When I follow the new contributor path, I land on building documentation; this page says the docs are built with Sphinx and use make to build. But when I dug deeper into the readme for the docs, it is mkdocs and markdown instead! And, you need to have a docker setup (which I learned when following the link to installation instructions).

This is because our older, developer-focused docs (https://github.com/pypi/warehouse/tree/main/docs/dev) are indeed rST and Sphinx, but our newer, user-focused docs (https://github.com/pypi/warehouse/tree/main/docs/user) are Markdown. The docs on building documentation is out of date but should reference both sets of docs.

@lwasser
Copy link
Contributor Author

lwasser commented Jan 9, 2025

Ok perfect. I wasn't able to get the docs to build locally using docker. I will try again, but now that I see I can use ci to view previews, that might be enough. i just submitted a pr that updates images only.

I can work on a separate small PR to try to make the new contributor experience a bit clearer. i think where i got confused was that the readme for the user docs directs me to the developer docs. And the developer docs lead you down a path of building the entire warehouse and are focused on the .rst sphinx developer docs without mentioning the user docs. 🙃

big sites like this are so hard to document! thank you all for the feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants