Docs guidelines: Move include for common attributes above the title #62912
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
openshift-ci
bot
added
the
size/S
|
🤖 Updated build preview is available at: Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/22124 |
rohennes
force-pushed
the
move-attributes-above-title
branch
from
98b41e8 to
6040261
Compare
|
LGTM! |
rohennes
force-pushed
the
move-attributes-above-title
branch
2 times, most recently
from
0a5e53d to
bbb1dcf
Compare
|
It's worth noting that if I put the include directive above the ID I get an asciidoctor error. So I've put it under the ID. |
|
/label peer-review-needed |
openshift-ci
bot
added
the
peer-review-needed
|
/label peer-review-in-progress |
openshift-ci
bot
added
the
peer-review-in-progress
|
LGTM /remove-label peer-review-in-progress |
openshift-ci
bot
added
peer-review-done
|
/label merge-review-needed |
openshift-ci
bot
added
the
merge-review-needed
kcarmichael08
added
merge-review-in-progress
| <3> Human readable title (notice the `=` top-level header) | ||
| <4> Includes attributes common to OpenShift docs. | ||
| <2> A unique (within OpenShift docs) anchor ID for this assembly. Use lowercase. Example: cli-developer-commands. | ||
| <3> Includes attributes common to OpenShift docs. |
There was a problem hiding this comment.
@kcarmichael08 - fixed! Good spot!
…avoid attributes not rendering in the title
rohennes
force-pushed
the
move-attributes-above-title
branch
from
bbb1dcf to
0c0dcbc
Compare
kcarmichael08
removed
the
merge-review-in-progress
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.
OCP Docs guidelines change
To avoid an attribute not resolving in the title, the include directive for common-attributes should be above the title so it's processed first.
Based on this issue: https://redhat-internal.slack.com/archives/C02KBD8A4UF/p1690471884037959
Version(s):
4.10+
Issue:
Based on this slack convo: https://redhat-internal.slack.com/archives/C02KBD8A4UF/p1690471884037959
Link to docs preview: