For the 3.x release we'd like to cleanup the handbook in http://community.aegirproject.org/handbook to the MD format.

Stored in Git on GitHub and rendered on https://aegir.readthedocs.org/ http://docs.aegirproject.org.

STEPS:

  1. Convert a page
  2. Cleanup markup
  3. Strip outdated content, anything from before 3.x
  4. Commit, push, pull request

Refs:
README: https://github.com/aegir-project/documentation
Conversion tool: https://domchristie.github.io/to-markdown/

Cleanup regular expressions

  • s/<\/?d[tfdl]>//g
  • s/<div.*\/div>// - Remove "Back to top" links

Comments

helmo’s picture

helmo commented
Issue summary: View changes
helmo’s picture

helmo commented
Issue summary: View changes
helmo’s picture

helmo commented

Can we put some banner on the community site to show on all doc pages that users should look at the new mkdocs....?

helmo’s picture

helmo commented
Issue summary: View changes

adding a notice is no longer needed as we're going to redirect the whole community site.

I've just converted the contrib modules page.

helmo’s picture

helmo commented
Issue summary: View changes
ergonlogic’s picture

ergonlogic
he/him
Primary language English
Location Montréal, Québec 🇨🇦
commented

Also, the http://docs.aegirproject.org CNAME record is working now. We should use that whenever referring to our docs site. This'll give us the flexibility of using something other than readthedocs.org for our docs, such as mkdocs hosted directly on github-pages.

ergonlogic’s picture

ergonlogic
he/him
Primary language English
Location Montréal, Québec 🇨🇦
commented
Title: [meta] Move docs to aegir.readthedocs.org » [meta] Move docs to docs.aegirproject.org
Issue summary: View changes
gboudrias’s picture

gboudrias commented

Found this while rummaging through issues, what's missing here?

ergonlogic’s picture

ergonlogic
he/him
Primary language English
Location Montréal, Québec 🇨🇦
commented
Status: Active » Fixed

While docs can always use improvement, I think this particular issue is done.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.