Build links to the Flows IDE for rendered pages#17
Merged
sirosen merged 1 commit intoglobus:mainfrom Aug 6, 2025
Merged
Conversation
sirosen
requested review from
MaxTueckeGlobus,
ada-globus,
derek-globus,
kurtmckee and
m1yag1
as code owners
kurtmckee
previously approved these changes
Aug 5, 2025
Update the `build-doc-bundle` script to create a gzip-encoded link to the example flows in the Flows IDE. The IDE link is passed to the asciidoc content by setting it as an attribute of the doc, which the content can then reference in a `link:` directive. For now, as a simple matter of simplicity and uniformity, the link is dropped, unadorned, at the top of each page where it is supported. Because the compute examples contain multiple definitions and therefore can't build simple links, an exclude config is supported to disable the links for these examples.
Member
Author
|
I forgot to handle the I compared the result to confirm it's still good. |
kurtmckee
approved these changes
Aug 5, 2025
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.
Update the
build-doc-bundlescript to create a gzip-encoded link to the example flows in the Flows IDE.The IDE link is passed to the asciidoc content by setting it as an attribute of the doc, which the content can then reference in a
link:directive.For now, as a simple matter of simplicity and uniformity, the link is dropped, unadorned, at the top of each page where it is supported.
Because the compute examples contain multiple definitions and therefore can't build simple links, an exclude config is supported to disable the links for these examples.
I've done a test render and confirmed that the Flows IDE is able to read these links.
Here's what a render will look like on the docs site: