Conversation
RaphvK
marked this pull request as draft
July 30, 2026 06:51
Contributor
Author
|
I will add triggering the docs generation as downstream pipeline in this PR |
cgeller
approved these changes
Jul 30, 2026
RaphvK
changed the title
RaphvK
commented
Jul 30, 2026
| # openadstack submodule and builds the docs from exactly these changes. | ||
| OPENADSTACK_REF: ${{ github.ref_name }} | ||
| DOWNSTREAM_REPO: openads-project/openads-project.github.io | ||
| DOWNSTREAM_REF: downstream-pipeline # TODO: switch to main |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| DOWNSTREAM_REF: downstream-pipeline # TODO: switch to main | |
| DOWNSTREAM_REF: main |
apply once merged: openads-project/openads-project.github.io#9
This reverts commit 5633e8b.
RaphvK
marked this pull request as ready for review
July 30, 2026 07:34
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
2 participants
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.
The inline HTML links cannot be resolved by Sphinx HTML generation (see here). So, I replaced them with conventional markdown links. Somehow, the icon used in the link to the "architecture" section had to be replaced to make that work.
To ensure that changes in markdown files in this repository are also validated and updated in the OpenADS docs repo, a downstream workflow was added, that is triggered on changes in
*.mdfiles. It triggers a docs rebuild in the downstream repo on changes in markdown files here using the branch triggering the downstream workflow. When changes in markdown files are commited to the main branch here, a new deployment to GitHub Pages (https://openads-project.github.io) is automatically triggered in the docs repo.Tests