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

docs(private packages): rewrite pip-compile section #29725

Conversation

HonkingGoose
Copy link
Collaborator

Changes

  • Rewrite the pip-compile section:
    • Use Material for MkDocs style admonition, bump to caution level styling
    • Use lists
    • Add headings to split information into clearer chunks
    • Explain who needs the info in the self-hosted section
    • Split long sentences
    • Use the word must when users must do something

Context

Follow up after:

I went looking into this file because the admonition the author added is in the GitHub Markdown style, which Material for MkDocs does not render properly. But then I found other bits, and it ballooned into this PR. 😄

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@viceice
Copy link
Member

viceice commented Jun 17, 2024

@craigds can you review for correctness?

@rarkins rarkins added this pull request to the merge queue Jun 17, 2024
Merged via the queue into renovatebot:main with commit c8872ed Jun 17, 2024
37 checks passed
@HonkingGoose HonkingGoose deleted the docs/follow-up-to-29421-rewrite-pip-compile-section branch June 17, 2024 16:16
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 37.410.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants