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

chore(stages): add orchestration docs under usage section #356

Merged
merged 9 commits into from
Apr 13, 2023

Conversation

ecrupper
Copy link
Contributor

I think it would be worth while to add more examples / explanations for the various orchestration tools given to users when it comes to stages, such as needs and independent. Further, I think outlining the behavior of stage pipelines in the context of ruleset pruning can be very helpful.

Let me know if you think this content belongs elsewhere in the docs or if you have any edits / comments!

@ecrupper ecrupper self-assigned this Apr 11, 2023
@ecrupper ecrupper requested a review from a team as a code owner April 11, 2023 18:55
wass3rw3rk
wass3rw3rk previously approved these changes Apr 11, 2023
Copy link
Member

@wass3rw3rk wass3rw3rk left a comment

Choose a reason for hiding this comment

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

minor nitpick, otherwise, nice job

content/usage/stage_orchestration.md Outdated Show resolved Hide resolved
Co-authored-by: David May <49894298+wass3rw3rk@users.noreply.github.com>
content/usage/stage_orchestration.md Outdated Show resolved Hide resolved
content/usage/stage_orchestration.md Outdated Show resolved Hide resolved
content/usage/stage_orchestration.md Outdated Show resolved Hide resolved
- echo $VELA_REPO_FULL_NAME
```

So in fact, in this scenario, the `run-first` stage and the `y-stage` begin simultaneously, even though `y-stage` "needed" `compile-time-ruleset-stage` which "needed" `run-first` in the original pipeline.
Copy link
Member

Choose a reason for hiding this comment

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

Wow! Yes this needed to be documented. That is surprising.

content/usage/stage_orchestration.md Outdated Show resolved Hide resolved
content/usage/stage_orchestration.md Outdated Show resolved Hide resolved
@ecrupper ecrupper merged commit 7aadf8c into main Apr 13, 2023
@ecrupper ecrupper deleted the improve-staging-orchestration-docs branch April 13, 2023 16:39
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.

4 participants