Skip to content

CONTRIBUTING: Update directions for updating documentation#1438

Merged
vojtechtrefny merged 1 commit intostoraged-project:mainfrom
vojtechtrefny:main_contributing-update
Nov 25, 2025
Merged

CONTRIBUTING: Update directions for updating documentation#1438
vojtechtrefny merged 1 commit intostoraged-project:mainfrom
vojtechtrefny:main_contributing-update

Conversation

@vojtechtrefny
Copy link
Member

@vojtechtrefny vojtechtrefny commented Nov 24, 2025

Summary by Sourcery

Documentation:

  • Revise documentation publishing steps to point contributors to the storaged-project.github.io repository and blivet folder instead of using the gh-pages branch directly.

@sourcery-ai
Copy link

sourcery-ai bot commented Nov 24, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This 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 process

flowchart 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]
Loading

File-Level Changes

Change Details Files
Update documentation publishing instructions to point to the Storaged project website repository and blivet folder.
  • Replace the old flow of copying built HTML docs to a temporary directory, switching to the gh-pages branch, and copying them back with the new target location and workflow
  • Add a direct link to the storaged-project.github.io repository where the documentation should now be copied and committed
CONTRIBUTING.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@vojtechtrefny vojtechtrefny merged commit 79376d2 into storaged-project:main Nov 25, 2025
15 of 16 checks passed
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.

1 participant