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

Ryan Blough reassigned HDDS-10683:
----------------------------------

    Assignee: Ryan Blough

> Add table of all Ozone configurations generated from ozone-default.xml
> ----------------------------------------------------------------------
>
>                 Key: HDDS-10683
>                 URL: https://issues.apache.org/jira/browse/HDDS-10683
>             Project: Apache Ozone
>          Issue Type: Sub-task
>            Reporter: Ethan Rose
>            Assignee: Ryan Blough
>            Priority: Major
>
> While common configurations should be called out as needed in the docs, there 
> are many specialized configurations that may not fit in any of the main docs 
> sections but should still be searchable on the website. We can add create a 
> page similar to 
> [Hadoop|https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/core-default.xml]
>  but nicer with the following process:
> 1. Add a build step in the website that pulls ozone-default.xml from the main 
> apache/ozone repo.
> 2. Run a custom script that converts the XML to a markdown table to generate 
> the webpage.
>  * Reading the XML can be done with an existing CLI XML parser. Outputting as 
> a markdown table should be simple enough if we already know the structure of 
> the XML.
> We only need to pull the config file for the "next" (master) version of the 
> docs. For already released versions, we can commit the generated markdown 
> page directly.



--
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