CONTRIBUTING: Update directions for updating documentation#1438
Merged
vojtechtrefny merged 1 commit intostoraged-project:mainfrom Nov 25, 2025
Merged
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR updates the CONTRIBUTING documentation to reflect the new process for publishing generated HTML docs to the Storaged project website repository instead of the old gh-pages workflow. Flow diagram for updated documentation publishing processflowchart TD
A[Start: New release ready] --> B[Run make -C doc html to generate HTML docs]
B --> C[Verify docs generated in doc/_build/html]
C --> D[Open storaged project website repository]
D --> E[Locate blivet folder in website repository]
E --> F[Copy contents of doc/_build/html into blivet folder]
F --> G[Review changes in website repository]
G --> H[Commit changes in website repository]
H --> I[Push changes to remote website repository]
I --> J[End: Documentation for new release published]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Documentation: