Skip to content

docs(orchestrator): Move the guide to a dedicated orchestrator/README.md file - #80

Merged
rm3l merged 1 commit into
redhat-developer:mainfrom
rm3l:chore/move_orchestrator_guide_to_orchestrator_README_file
Aug 19, 2025
Merged

docs(orchestrator): Move the guide to a dedicated orchestrator/README.md file#80
rm3l merged 1 commit into
redhat-developer:mainfrom
rm3l:chore/move_orchestrator_guide_to_orchestrator_README_file

Conversation

@rm3l

@rm3l rm3l commented Aug 19, 2025

Copy link
Copy Markdown
Member

Description

Follow-up to #64 (comment)

Similar to the 'developer-lightspeed' structure, this would make it easy to find and super obvious as a starting place for the user.

Which issue(s) does this PR fix or relate to

PR acceptance criteria

  • Tests
  • Documentation

How to test changes / Special notes to the reviewer

Summary by Sourcery

Move the Orchestrator workflow guide into its own top-level README and update references accordingly

Enhancements:

  • Relocate the orchestrator guide from docs/orchestrator-workflow-guide.md to orchestrator/README.md
  • Refresh internal compose and example links in the moved guide to use correct relative paths
  • Update the main README to point to the new orchestrator README location

…ME.md' file

Similar to the 'developer-lightspeed' structure, this would make it
easy to find and super obvious as a starting place for the user.
@sourcery-ai

sourcery-ai Bot commented Aug 19, 2025

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR centralizes the orchestrator workflow guide into a dedicated README by relocating the file and updating all relative links to reflect the new structure.

File-Level Changes

Change Details Files
Relocate orchestrator workflow guide to its own README
  • moved orchestrator-workflow-guide.md to orchestrator/README.md
  • updated main README navigation link to point to the new orchestrator/README.md
orchestrator/docs/orchestrator-workflow-guide.md
orchestrator/README.md
README.md
Adjust relative paths within the relocated guide
  • fixed compose.yaml references to ../compose.yaml and ./compose.yaml as needed
  • updated workflow-examples directory and README links to use './workflow-examples'
orchestrator/README.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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

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.

@rm3l rm3l changed the title chore(orchestrator): Move the guide to a dedicated 'orchestrator/README.md' file chore(orchestrator): Move the guide to a dedicated orchestrator/README.md file Aug 19, 2025
@rm3l rm3l changed the title chore(orchestrator): Move the guide to a dedicated orchestrator/README.md file docs(orchestrator): Move the guide to a dedicated orchestrator/README.md file Aug 19, 2025
@rm3l
rm3l merged commit 10277e0 into redhat-developer:main Aug 19, 2025
25 checks passed
@rm3l
rm3l deleted the chore/move_orchestrator_guide_to_orchestrator_README_file branch August 19, 2025 11:09
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