HDDS-9856. Add quick start documentation

[kerneltime]

Generated-by: Claude and Gemini

What changes were proposed in this pull request?

Add quick start documentation

What is the link to the Apache Jira?

HDDS-9856

How was this patch tested?

Check off which of the following tests were done on this change. If additional testing was done, please elaborate here as well.

• The CI checks on my fork are passing
• I verified the rendered content using a local preview
• I manually verified the steps provided in this change work as described

[Copilot]

Pull Request Overview

This PR introduces a quick start guide for Apache Ozone, including a landing page with custom cards, a detailed reading/writing data guide, and complete installation instructions for Docker, Kubernetes, and Bare Metal.

• Replace the autogenerated DocCardList on quick-start index pages with custom card layouts
• Add a full “Reading and Writing Data” tutorial covering Ozone Shell, OFS, and S3 interfaces
• Expand installation docs with step-by-step Docker, Kubernetes, and Bare Metal instructions

Reviewed Changes

Copilot reviewed 5 out of 10 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
docs/02-quick-start/README.mdx	Update quick start landing page with custom cards
docs/02-quick-start/02-reading-writing-data.md	Add comprehensive reading/writing data guide
docs/02-quick-start/01-installation/README.mdx	Update installation landing page with custom cards
docs/02-quick-start/01-installation/02-kubernetes.md	Flesh out Kubernetes deployment guide
docs/02-quick-start/01-installation/03-bare-metal.md	Flesh out Bare Metal installation guide

Comments suppressed due to low confidence (4)

docs/02-quick-start/README.mdx:7

• The DocCardList import is no longer used after removing ; consider removing this import to clean up unused code.

import DocCardList from '@theme/DocCardList';

docs/02-quick-start/01-installation/README.mdx:7

• The DocCardList import is no longer used after removing ; please remove this unused import for clarity.

import DocCardList from '@theme/DocCardList';

docs/02-quick-start/02-reading-writing-data.md:17

• [nitpick] The strengths listed in the table lack separators between items, which reduces readability; consider adding commas or semicolons between list entries.

| **Ozone Shell** | - Full feature access Advanced operations Detailed metadata                             | - Administrative tasks Bucket/volume management Quota/ACL management       |

docs/02-quick-start/02-reading-writing-data.md:252

• [nitpick] Using an HTML
  tag inside a markdown table may not render correctly; consider using markdown line breaks (two spaces) or separate rows for clarity.

| vol1/bucket1/file.txt | `/vol1/bucket1/file.txt` | `ofs://<ozone service id>/vol1/bucket1/file.txt` | `s3://bucket1/file.txt` <br/>(if S3V configured to serve vol1) |

[ivandika3]

@kerneltime Thanks for the quick start documentation. Left some comments.

[ivandika3]

Currently, this causes the page to have some leftover link to the subpages.

Can we disable the subpages link for the quick start so the bottom links can be removed?

[ivandika3]

Same case for the Quick Start page

[ivandika3]

Sometimes when I clicked both "Installation" and "Reading & Writing Data", I encountered "Page Not Found" since I was routed to /docs/installation instead docs/quick-start/installation/.

Can be reproduced by

1. Going to the home page
2. Press "Get Started"
3. Press "Installation" or "Reading & Writing Data".

If I access the Quick Start from the side panel, it works fine.

Maybe we need to use an absolute path for the "href".

[jojochuang]

@kerneltime there's a cspell.yaml conflict.
Apart from that, I'd like to have this merged. @ivandika3 's comment is valid and we need to address them in a follow-up task.

[errose28]

I am -1 on adding custom icons for each landing page:

• It reduces usability over the default values
  • Default values tell you whether you are going to another subsection landing page or an individual docs page. This information is lost now.
• Its an extra barrier for people to add new sections
  • It may be easy to write this off now, but experience has shown that any small barrier to adding docs will prevent people from doing it. The idea behind the new site was that docs updates could be done using only markdown.
  • If people have to hunt down images that match whatever abstract section they want to add is will unnecessarily block them from simply adding markdown content.
• It is more to maintain in a project that we want to be as low maintenance as possible
  • Even with the help of LLMs we are still responsible for everything we put here.
  • To keep the site running smoothly we should avoid adding too much "eye candy" that goes beyond keeping the site looking professional and functional.
  • Heavy customizations like this can and likely will break as the site itself and docusausurs underneath evolves. When that happens it will be a low priority thing that we do not have a good handle on fixing and will likely remain broken in the prod deployment for a while, or unnecessarily block us from upgrading docusuaurus.

I am +1 for changing the icons docusaurus uses as default for subesctions vs individual pages though. I'm sure bootstrap icons has some nicer icons than the colored folder and page that docusausus puts there by default. If we can swap those in it would be reused automatically across all sections.

If we want to continue this discussion, it is probably best as its own issue independent of the docs added here (which reinforces my point). I suggest removing all custom icons from docs updates for now so we can focus on content without being blocked on style changes like this.