Skip to content

HDDS-5189. fix markdown files to make them hugo83 compatible (and valid)#2232

Merged
vivekratnavel merged 3 commits intoapache:masterfrom
elek:hugo83
May 14, 2021
Merged

HDDS-5189. fix markdown files to make them hugo83 compatible (and valid)#2232
vivekratnavel merged 3 commits intoapache:masterfrom
elek:hugo83

Conversation

@elek
Copy link
Member

@elek elek commented May 10, 2021

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?

./hadoop-ozone/dev-support/checks/docs.sh
  • full ci test on my fork

@elek elek requested a review from smengcl May 10, 2021 12:24
Copy link
Contributor

@adoroszlai adoroszlai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @elek for finding the root cause. It looks like some extra whitespace is still leftover.

Returns all the ContainerMetadata objects.

```json
```json
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a number of closing ``` markers with indentation, which do not end the code section.

closing

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

image

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:

image

@adoroszlai adoroszlai requested a review from vivekratnavel May 14, 2021 06:29
Copy link
Contributor

@vivekratnavel vivekratnavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 LGTM.

@vivekratnavel vivekratnavel merged commit 727b258 into apache:master May 14, 2021
@vivekratnavel
Copy link
Contributor

@elek Thanks for working on this and @adoroszlai for the review and contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants