Fix cross references in generated API references #48
Conversation
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
k8s-ci-robot
added
cncf-cla: yes
|
/retest |
|
Have to close and reopen to trigger a retest? |
|
/approve |
In previous commit, we have enabled the API reference doc to show full group names, however, due to implementation constraints (the use of brodocs docker image), the reformatted H1 headers are not producing anchor IDs properly. This PR reverses the H1 header generated. Other issues fixed: - .gitignore pointing to some non-existent files/dirs - config.yaml was using v1alpha1 version of VolumeAttachment as default, so the navigation bar is not working properly. - config.yaml was using v1beta1 version of APIService which prevents the navigation bar from working properly. - Added handler to special character sequences such as '*', '*/scale', 'pods/*' and '*/*' which had been incorrectly translated into <em> by the markdown Node.js module. - Other links fixed for cross-references. Will continue digging how to simplify the reference doc generation.
|
@steveperry-53 Done. |
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.
In previous commit, we have enabled the API reference doc to show full
group names, however, due to implementation constraints (the use of
brodocs docker image), the reformatted H1 headers are not producing
anchor IDs properly. This PR reverses the H1 header generated.
Other issues fixed:
so the navigation bar is not working properly.
navigation bar from working properly.
'pods/' and '/*' which had been incorrectly translated into
by the markdown Node.js module.
Will continue digging how to simplify the reference doc generation.