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 front matter to docs #927

Open
adambkaplan opened this issue Oct 29, 2021 · 0 comments
Open

Add Hugo front matter to docs #927

adambkaplan opened this issue Oct 29, 2021 · 0 comments
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@adambkaplan
Copy link
Member

The community wants to keep docs close to the code, and implement a sync process to add the documentation to the shipwright.io website. See shipwright-io/website#29.

Today the sync is a manual process that involves me manually copying content from this repository, then applying the Hugo front matter that organizes the presentation of articles in the table of contents. As a first step at improving this process, the front matter should be added to the docs in this repository. The articles that are copied over (with their front matter) can be found here. The corresponding markdown can be found here.

Most Hugo documentation suggests that the front matter needs to be visible in the Markdown file, but this is not the case. The front matter can be inserted in an HTML comment, and Hugo will read it just fine.

/kind documentation

@openshift-ci openshift-ci bot added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 29, 2021
@adambkaplan adambkaplan added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Oct 29, 2021
@adambkaplan adambkaplan added this to the release-v0.7.0 milestone Nov 3, 2021
@qu1queee qu1queee modified the milestones: release-v0.9.0, Backlog Feb 23, 2022
@adambkaplan adambkaplan added the hacktoberfest Hacktoberfest Candidate Issues label Sep 28, 2022
@qu1queee qu1queee added lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. and removed good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. hacktoberfest Hacktoberfest Candidate Issues labels May 23, 2024
@qu1queee qu1queee removed this from the Backlog milestone May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
No open projects
Development

No branches or pull requests

3 participants