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: simplify repdroducible guide #11535

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Conversation

humitos
Copy link
Member

@humitos humitos commented Aug 12, 2024

  • Rephrase the readthedocs.yaml section since it's mandatory now
  • Add a small YAML that shows pinning OS and tools
  • Only show python.install.requirements for Python dependencies section
  • Remove "Good" small section since we removed the "Bad" one already
  • Remove "Check list" since it's just duplicated content

📚 Documentation previews 📚

- Rephrase the `readthedocs.yaml` section since it's _mandatory_ now
- Add a small YAML that shows pinning OS and tools
- Only show `python.install.requirements` for Python dependencies section
- Remove "Good" small section since we removed the "Bad" one already
- Remove "Check list" since it's just duplicated content
@humitos humitos requested a review from a team as a code owner August 12, 2024 10:45
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Solid improvements 👍

@humitos humitos merged commit 42478f4 into main Aug 12, 2024
8 of 9 checks passed
@humitos humitos deleted the humitos/simplify-reproducible-guide branch August 12, 2024 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants