OpenShift documentation update and cleanup

jamesread commented 4 years ago

Hey folks,

This PR is to try and update, improve and cleanup the OpenShift parts of the documentation.

I just installed OpenEBS on my testing cluster tonight (nice work, by the way!) and took it upon myself to raise a PR in areas of the documentation that I personally struggled with. I've built the docs locally and tested for formatting/links. I've signed off this PR, and reviewed the CoC. I did check the README, so hope I did not miss anything vital for my first commit, if so, I do apologize!

Overview of changes;

Changes faq.md, kb.md, prereqruisites.md, and moves everything into a section of kb.md. I figured that faq.md and prereqresites.md were both quite brief, and might as well link to one section that it easier to keep updated.
Added a couple of recent OpenShift screenshots, cleaned up some of the English and examples, removed repetition.

Description of choices / assumptions;

I took the design choice to remove several version numbers (4.2, 4.1, etc), as these will all go out of date quickly (latest version is 4.5). The information is relevant to all versions of 4 really, so I used "4.x" in one place.
I'm not sure about your testing/supported/certification policy - but I attempted to shorten & tidy up what looked like a statement of "we've tested this" into a single table - this might be misleading or not something you want. See: https://github.com/openebs/openebs-docs/commit/7df9cdb33a76000ee7f1eafe7bc07ddfae64df05#diff-bd20129783723691c7610673b2ed3abcR258
I shortened the installation section to basically say "just use the operator", as I assume that is what 90% of users will do.
The files were a mix of markdown and HTML, I mostly wrote/re-wrote sections in markdown to keep it simple.

Note; I do work for Red Hat and spend a lot of my time with OpenShift, but I'm not associated with the engineering groups. This doc commit has been done entirely in my own time, out of my own interest, during my weekend. I'm not asking for/expecting any attribution, and this is purely because I thought it may be of help to others :-)

Signed-off-by: jamesread contact@jwread.com

netlify[bot] commented 4 years ago

Deploy preview for openebs-docs-staging ready!

Built with commit 7df9cdb33a76000ee7f1eafe7bc07ddfae64df05

https://deploy-preview-870--openebs-docs-staging.netlify.app

kmova commented 4 years ago

@jamesread this is awesome!! Thank you!!

openebs-archive / openebs-docs

OpenShift documentation update and cleanup #870