att-comdev / openstack-helm

PROJECT HAS MOVED TO OPENSTACK
https://github.com/openstack/openstack-helm
69 stars 41 forks source link

WIP: ToC Preparation for Openstack #296

Closed v1k0d3n closed 7 years ago

v1k0d3n commented 7 years ago

This is a complete work in progress, but it starts to set up a rough framework for docs. This is only a commit placeholder for now, as I'll continue to work through some of the docs and empty readme (as placeholders) this week.

This places docs into the following top tier categories:

In each of these sections should follow a general theme. The Openstack-Helm project clearly draws these lines on behalf of operators/developers, and documentation can simply cross-reference one another. More to come over the next coming weeks...

v1k0d3n commented 7 years ago

most items are corrected as requested. now i'm looking for additional feedback @intlabs and @wilkers-steve.

i know we had talked about this for a few days internally, but the effort was really about nailing down the layout and Table of Contents prior to going into openstack. most of the reviews were based on doc sprawl because of improvements made to the project over time. I'm really thankful these were caught at this point in time. but if you could please provide feedback on the general layout and how the docs will eventually shape, it would be great. it's something that can get side-ways pretty fast, and i don't want the larger community to assume that plans haven't been well thought out ahead of time (from an architecture standpoint). it's time to move into a documentation phase where we can lay out that vision for the rest of the community.

v1k0d3n commented 7 years ago

@intlabs and @wilkers-steve can you lay some fresh eyes on this please?