Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Transition of docs site to production #43

Open
13 tasks
makruger opened this issue Aug 20, 2016 · 0 comments
Open
13 tasks

Transition of docs site to production #43

makruger opened this issue Aug 20, 2016 · 0 comments

Comments

@makruger
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant