HDDS-5189. fix markdown files to make them hugo83 compatible (and valid)#2232
Merged
vivekratnavel merged 3 commits intoapache:masterfrom May 14, 2021
Merged
HDDS-5189. fix markdown files to make them hugo83 compatible (and valid)#2232vivekratnavel merged 3 commits intoapache:masterfrom
vivekratnavel merged 3 commits intoapache:masterfrom
Conversation
adoroszlai
requested changes
May 10, 2021
Contributor
adoroszlai
left a comment
There was a problem hiding this comment.
Thanks @elek for finding the root cause. It looks like some extra whitespace is still leftover.
| Returns all the ContainerMetadata objects. | ||
|
|
||
| ```json | ||
| ```json |
Contributor
Member
Author
There was a problem hiding this comment.
Good point.
This is the result when I use IDE instead of CLI ;-) Fixed now with
sed -i -E 's/[[:space:]]+```/```/g' ReconApi.zh.md`
But after I tested with hugo serve I found that the rendering still not perfect. Section titles are hard to identify/read:
Here it's not clear that 'containers/unhealthy is a section title'
https://ozone.apache.org/docs/1.1.0/interface/reconapi.html
I fixed this styling, too. And now it seems to be more readable:
adoroszlai
approved these changes
May 11, 2021
Contributor
|
@elek Thanks for working on this and @adoroszlai for the review and contribution. |
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
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.



What changes were proposed in this pull request?
Hugo 0.83 is reported to be failing while generating Ozone docs. See https://issues.apache.org/jira/browse/HDDS-5189 for more details.
What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-5189
How was this patch tested?