Documentation

[emshvac]

I have seen the Jira for documentation and it seems no progress has been happening. I there is someone out there that is familiar with production instances we would be happy to contribute. We have figured out through testing how many of the undocumented features / non features work. We would like to ensure that what we are contributing follows apaches standards as well as ensure the documentation is robust for all.

Any contributors out there willing to partner up?

Edit: I would like to not have to reference Clouderas documentation....

[errose28]

Hi @emshvac thanks for the interest in the docs, and sorry for the late response as I was traveling last week. We are well aware of how difficult it is for open source users to get started with Ozone, which is part of what inspired the initiative to completely overhaul Ozone's website and documentation. Here are some references about the project:

• HDDS-9225: This is the parent Jira for "Website V2" which is an almost complete re-write of the Ozone website and documentation.
  • Attached to that Jira is a document with objectives and a plan, however at this point Jira is a more concrete reference for planning than that document.
• https://github.com/apache/ozone-site/tree/HDDS-9225-website-v2: This is the branch where we are putting changes to the new website. They are completely independent of the current site, which is also receiving updates as needed.
  • See the README and contributing guide in this branch for more details.
• https://ozone-site-v2.staged.apache.org: This is a staging domain for the current content in the new website while it is in progress.
  • In the docs section, note that a skeleton with subsections and pages is already created, but almost all the content still needs to be filled in.

Although I've been leading the project, I'll admit I have not been able to give it the attention it deserves due to other responsibilities developing core Ozone. I think the same is true for a lot of other Ozone devs as well, but it will take a village to fill in the 200-300 pages of docs that are outlined in the new site's skeleton.

We would like to ensure that what we are contributing follows apaches standards as well as ensure the documentation is robust for all.

Check out the contributing guide I linked above to get started, and reach out with any questions you may have on the process. Feel free to tag me on GitHub for docs reviews. Additionally, updates to Ozone's current docs at ozone.apache.org/docs are also appreciated.

[mosleyit]

@errose28 Ethan thanks for this. I am responding from my personal account but @emshvac is my company account. I can do my best to help with the bare metal documentation. I know there are a lot of changes between edge and 1.4.1 but I can at least document a lot of what I found. Even if time constrained sending in some markdowns with what we have found.

We really would like to see this project succeed.