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

Integrate external sru docs #74

Merged
merged 9 commits into from
Jan 28, 2025
Merged

Conversation

dviererbe
Copy link
Collaborator

This PR integrates and refers to the new SRU documentation: https://canonical-sru-docs.readthedocs-hosted.com/en/latest/

The dedicated SRU doc (introduced with #69) is moved to explanation/development-process and reduced to the most important information, just to give a brief overview of the process.

@dviererbe dviererbe added this to the 2.0 Release milestone Oct 3, 2024
@dviererbe dviererbe requested review from rkratky and s-makin October 3, 2024 14:52
Copy link
Collaborator

@s-makin s-makin left a comment

Choose a reason for hiding this comment

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

Thanks, generally looks good! I've spotted some nits, and some other things that are blocking the automated checks. In addition to the inline comments:

  1. You'll want to add "SRUs" and "StableReleaseUpdates" to the spelling ignore list
  2. Deleting the stable-release-udpates.rst file has broken a link in debian-merges-and-syncs.rst at line 42
  3. There are two links that say "broken" - they're not really broken, but they are redirecting so we probably want to update them:

Copy link
Collaborator

@rkratky rkratky left a comment

Choose a reason for hiding this comment

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

Thanks, @dviererbe! Some nitpicks and a necessary fix (updating the link to the removed SRU file).

#. Get the package with the SRU patch into the upload queue.
#. The SRU team will then review from the unapproved queue. When the upload is
ready, the SRU team accepts the upload into the proposed pocket.
#. Once the builds are ready, autopkgtest are triggered. Test the binaries
Copy link
Collaborator

Choose a reason for hiding this comment

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

dviererbe and others added 4 commits January 23, 2025 16:25
The removal of the file `docs/explanation/stable-release-updates.rst`
caused a broken link. This commit fixes the link.
Add glossary entries for teh terms:
- autopkgtest
- autopkgtest Cloud
- Debian Enhancement Proposal
- DEP
- DEP 8
@dviererbe
Copy link
Collaborator Author

@rkratky I incorporated your and Sallys feedback and fixed false negatives in the spellcheck. There are two links that say "broken", but they're not really broken. Can you re-review this PR?

@dviererbe dviererbe requested a review from rkratky January 23, 2025 15:28
Copy link
Collaborator

@rkratky rkratky left a comment

Choose a reason for hiding this comment

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

Thanks, @dviererbe.

@dviererbe dviererbe merged commit 4239f5c into 2.0-preview Jan 28, 2025
1 of 3 checks passed
@rkratky rkratky deleted the feat/integrate-external-sru-docs branch January 28, 2025 14:32
@dviererbe dviererbe added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 21, 2025
@dviererbe dviererbe removed this from the 2.0 Release milestone Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants