Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update gendocs script to generate front matter #245

Merged
merged 3 commits into from
Dec 6, 2017
Merged

Conversation

tamalsaha
Copy link
Contributor

No description provided.

@tamalsaha tamalsaha requested a review from sajibcse68 December 5, 2017 16:52
Copy link
Contributor

@sajibcse68 sajibcse68 left a comment

Choose a reason for hiding this comment

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

ID should be unique, url: <> missing, name: <> should be smaller otherwise it is broken in left menu.

menu:
product_searchlight_4.0.0:
identifier: hostfacts
name: Hostfacts
parent: reference
weight: 10
menu_name: product_searchlight_4.0.0
left_menu: product_searchlight_4.0.0
Copy link
Contributor

Choose a reason for hiding this comment

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

left_menu -> menu_name, following all

@@ -2,25 +2,24 @@
title: Hostfacts
menu:
product_searchlight_4.0.0:
identifier: hostfacts-hostfacts
identifier: hostfacts
Copy link
Contributor

Choose a reason for hiding this comment

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

Overwrites docs/reference/hostfacts/_index.md id. ID should be unique.
I followed, Identifier: <folder/parent name>- to avoid ID conflicts.

aliases:
- /products/searchlight/4.0.0/reference/hostfacts/hostfacts/
---
- products/searchlight/4.0.0/reference/hostfacts/hostfacts/
Copy link
Contributor

Choose a reason for hiding this comment

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

url: /products/searchlight/4.0.0/reference/hostfacts/ missing after menu_name: <>

@@ -2,25 +2,24 @@
title: Hyperalert
menu:
product_searchlight_4.0.0:
identifier: hyperalert-hyperalert
identifier: hyperalert
Copy link
Contributor

Choose a reason for hiding this comment

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

Overwrites docs/reference/hyperalert/_index.md ID.

name: Hyperalert
parent: hyperalert
weight: 10
weight: 0

product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
Copy link
Contributor

Choose a reason for hiding this comment

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

url: /products/searchlight/4.0.0/reference/hyperalert/ missing

identifier: hyperalert-check-component
name: Check Component
identifier: hyperalert-check-component-status
name: Hyperalert Check Component Status
Copy link
Contributor

Choose a reason for hiding this comment

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

Name: <> should be smaller otherwise it would be broken in left menu!

@@ -2,25 +2,24 @@
title: Searchlight
menu:
product_searchlight_4.0.0:
identifier: searchlight-searchlight
identifier: searchlight
Copy link
Contributor

Choose a reason for hiding this comment

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

ID conflicts with docs/reference/searchlight/_index.md

name: Searchlight
parent: searchlight
weight: 10
weight: 0

product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
Copy link
Contributor

Choose a reason for hiding this comment

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

url: /products/searchlight/4.0.0/reference/searchlight/ is missing

@tamalsaha
Copy link
Contributor Author

PTAL. Should be fixed now. I added *-cli suffix to identifiers to break the tie.

Copy link
Contributor

@sajibcse68 sajibcse68 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@tamalsaha tamalsaha merged commit a4da377 into master Dec 6, 2017
@tamalsaha tamalsaha deleted the fix-gendoc branch December 6, 2017 21:37
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.

2 participants