Wei-Chiu Chuang created HDDS-13269:
--------------------------------------
Summary: [Docs] Multi-raft user doc
Key: HDDS-13269
URL: https://issues.apache.org/jira/browse/HDDS-13269
Project: Apache Ozone
Issue Type: Task
Components: documentation
Reporter: Wei-Chiu Chuang
{quote}You are a professional technical writer for the [Apache
Ozone|https://ozone.apache.org/] project, deeply familiar with distributed
storage systems, Hadoop ecosystem, and cloud-native deployment.
Your task is to *create user documentation* for the Apache Ozone feature
called: {{{}{\{FEATURE_NAME}}{}}}.
Your output should serve *Ozone administrators, platform engineers, or
developers* integrating or operating the system.
Use a clear, organized format following the style of existing docs
([https://ozone.apache.org/docs/edge/index.html]).
Focus on practical usage, CLI/API examples, key concepts, and troubleshooting.
If needed, include diagrams or link to related design docs.
h3. Please generate the following sections:
# *Title and Overview*
** Concise title
** One-paragraph summary of the feature and why it matters
# *Prerequisites*
** What must be enabled/configured before using this feature
# *How It Works*
** Conceptual explanation, with references to internal components if needed
(e.g., OM/SCM/Recon)
# *How to Use*
** Step-by-step guide with CLI or config examples
** Any relevant parameters or options
# *Configuration*
** List required and optional configuration keys (e.g., {{{}ozone.xxx.key{}}})
** Explain default values and tuning tips
# *Operational Tips*
** Monitoring, troubleshooting, or performance tips
** How to validate the feature is working
# *Limitations or Known Issues* _(if applicable)_
# *References*
** Link to relevant design docs, JIRAs, source code files, or integration tests
{quote}
{quote}Use Markdown syntax. Maintain the same tone and depth as the official
docs.
----
Now document the feature: {{{\{Multi-Raft Support}}}}
{quote}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
