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

Add Hugo frontmatter to generated docs #539

Closed
rhuss opened this issue Dec 6, 2019 · 3 comments
Closed

Add Hugo frontmatter to generated docs #539

rhuss opened this issue Dec 6, 2019 · 3 comments
Assignees
Labels
kind/doc Issues and pull requests for documentations kind/feature New feature or request

Comments

@rhuss
Copy link
Contributor

rhuss commented Dec 6, 2019

In what area(s)?

Documentation

Describe the feature:

When creating the documentation for commands during the build process, the generated documentation should at least contains the front matter which is used by the knative.dev documentation generation is required.

For a first implementation, it's about the overall mechanism, to include the front-matter section which includes also the title as shown in the navigation.

There are two possible ways of how this could be implemented:

  • Extend the build generation directly in go-code to add the required header
  • Add a postprocessing step which takes the generated markdown and adds the required metadata.

Also, it needs to be discussed whether only 1 single set of reference documentation should be created or two sets, one for direct usage in the Github repo (as it is now) and one for inclusion in the website documentation.

Doing it in a postprocessing step would have the benefit that this script could run during site-generation, and hence would nicely decouple the responsibilities. Also, if it's only about adding a header file, then it's should be also technically easy to achieve.

References:

@rhuss rhuss added kind/feature New feature or request kind/doc Issues and pull requests for documentations labels Dec 6, 2019
@rhuss rhuss self-assigned this Dec 6, 2019
@rhuss
Copy link
Contributor Author

rhuss commented Feb 11, 2020

Will be implemented as part of #510 .

@rhuss rhuss mentioned this issue Feb 11, 2020
5 tasks
@navidshaikh
Copy link
Collaborator

/close

fixed by #680

@knative-prow-robot
Copy link
Contributor

@navidshaikh: Closing this issue.

In response to this:

/close

fixed by #680

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/doc Issues and pull requests for documentations kind/feature New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants