oi-docs icon indicating copy to clipboard operation
oi-docs copied to clipboard

Transition of docs site to production

Open makruger opened this issue 9 years ago • 0 comments

Things which should be done to make documentation site official:

  • [ ] Move all actual and relevant content of current handbook to new version.
  • [ ] Review new handbook content to avoid actual errors.
    • [ ] Review and mark existing Wiki handbook content as either obsolete or suitable for importation.
    • [ ] For items marked for importation insert placeholder link into new handbook referencing page(s) on Wiki to be imported.
    • [ ] Import content and mark imported content as a draft version.
    • [ ] Research and fix any obvious technical errors, when done, mark as ready for technical review.
    • [ ] Solicit technical reviews of items marked as ready for technical review.
  • [ ] Make look and feel of http://www.openindiana.org/ and documentation site similar.
    • [ ] Compare sites and create a list of areas which need work
    • [ ] Research what needs to change and how to change it.
    • [ ] Implement changes.
  • [ ] Investigate process for exporting docs as PDF and EPUB Need to look into what tools might work for this, and document the process for doing it. https://github.com/jgrassler/mkdocs-pandoc
  • [ ] Provide links to illumos documentation, open zfs documentation where necessary.

This is likely something which would be addressed during technical reviews as a part of the content importation process.

makruger avatar Aug 20 '16 22:08 makruger