[ 
https://issues.apache.org/jira/browse/HDDS-14512?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Chia-Chuan Ho reassigned HDDS-14512:
------------------------------------

    Assignee: Chia-Chuan Ho

> Enforce that page links omit number prefixes and file extensions
> ----------------------------------------------------------------
>
>                 Key: HDDS-14512
>                 URL: https://issues.apache.org/jira/browse/HDDS-14512
>             Project: Apache Ozone
>          Issue Type: Sub-task
>          Components: website
>            Reporter: Ethan Rose
>            Assignee: Chia-Chuan Ho
>            Priority: Major
>
> When linking from one internal page to another, the links should not use 
> number prefixes or file extensions. These can be changed if the ordering or 
> format of the target page is updated and all links will break, failing the 
> build unnecessarily. Docusaurus can still resolve links without these. For 
> example, this would be a correction to an existing page:
> {code:java}
> diff --git a/docs/03-core-concepts/01-architecture/06-recon.md 
> b/docs/03-core-concepts/01-architecture/06-recon.md
> index dedb7b6dc..7a98760cb 100644
> --- a/docs/03-core-concepts/01-architecture/06-recon.md
> +++ b/docs/03-core-concepts/01-architecture/06-recon.md
> @@ -52,12 +52,12 @@ Recon can integrate with any Prometheus instance 
> configured to collected metrics
>  
>  ## API Reference
>  
> -[Link to complete API 
> Reference](../../05-administrator-guide/03-operations/09-observability/02-recon/02-recon-rest-api.md)
> +[Link to complete API 
> Reference](../../administrator-guide/operations/observability/recon/recon-rest-api)
>  
>  ## Persisted state
>  
> -- A local copy of [OM database](./02-ozone-manager.md#persisted-state)
> -- A local copy of [SCM 
> database](./03-storage-container-manager.md#persisted-state)
> +- A local copy of [OM database](./ozone-manager#persisted-state)
> +- A local copy of [SCM database](./storage-container-manager#persisted-state)
> {code}
> This can be done by adding regex validation to the {{MarkdownPreprocessor}} 
> function in {{{}docusaurus.config.js{}}}, similar to how we validate front 
> matter. See [https://docusaurus.io/docs/api/docusaurus-config#markdown].



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to