[
https://issues.apache.org/jira/browse/HDDS-9866?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17793978#comment-17793978
]
Ethan Rose commented on HDDS-9866:
----------------------------------
Below are some suggestions based on the initial website skeleton. These should
be simple to implement with shell scripts and
[yq|https://mikefarah.gitbook.io/yq/] which also supports frontmatter.
* All docs directories/sections have
[\_category\_.yml|https://docusaurus.io/docs/sidebar/autogenerated#category-item-metadata]
with only the {{label}} field defined.
* Only allow the following properties in [yaml
frontmatter|https://docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter].
The rest should be inferred from the document itself.
** {{slug: /}} all other slugs should be generated from file names.
** {{sidebar_label}} if the sidebar label should be different/shorter than the
page title.
** {{tags}} if we want to use these in the future.
* File and directory names in docs should use kebab case.
** Coupled with the above checks, This should mean all URLs in the docs section
use kebab case. We probably want to generalize this check for the entire site.
* Every file and directory in the docs section should have a [number
prefix|https://docusaurus.io/docs/next/sidebar/autogenerated#using-number-prefixes],
and these should be continuous integers.
** Links within docs section should be [relative to work with
versioning|https://docusaurus.io/docs/next/versioning#link-docs-by-file-paths].
> Add GitHub Actions checks for consistent documentation formatting
> -----------------------------------------------------------------
>
> Key: HDDS-9866
> URL: https://issues.apache.org/jira/browse/HDDS-9866
> Project: Apache Ozone
> Issue Type: Sub-task
> Reporter: Ethan Rose
> Priority: Major
>
> Docusaurus provides multiple ways to set up the docs pages. We can enforce
> consistent use of these options across docs pages in a CI check.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
