DOC-4217: Add “page source” links to preview-src pages #101
Conversation
This file contains 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
|
UI bundle preview build successful! ✅ |
|
Antora site build successful! ✅ |
|
UI bundle preview build successful! ✅ |
|
Antora site build successful! ✅ |
colegoldsmith
approved these changes
Feb 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Jira: DOC-4217
The docs-ui preview is going to be used more frequently by writers as a reference for AsciiDoc formatting. As such, writers will need quick access to the AsciiDoc source files for each of the pages in the preview to view the underlying syntax. However, because the “Edit this page” button isn't present in the preview, we should manually specify the source file link at the top of each preview source page.
Draft example: https://riptano.github.io/docs-ui/DOC-4217-preview-source-links/asciidoc/text-formatting.html
In addition, the README is out of date with some of the latest enhancements to docs-ui automation. I've made a first high-level pass at documenting these changes.
README preview: https://github.com/riptano/docs-ui/blob/c33a5775e295efffde64f3207920ae1028780ba6/README.adoc