Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June.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:
- Convert a page
- Cleanup markup
- Strip outdated content, anything from before 3.x
- 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]>//gs/<div.*\/div>//- Remove "Back to top" links
Comments
Comment #1
helmo commentedComment #2
helmo commentedComment #3
helmo commentedCan we put some banner on the community site to show on all doc pages that users should look at the new mkdocs....?
Comment #4
helmo commentedadding a notice is no longer needed as we're going to redirect the whole community site.
I've just converted the contrib modules page.
Comment #5
helmo commentedComment #6
ergonlogicAlso, 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.
Comment #7
ergonlogicComment #8
gboudrias commentedFound this while rummaging through issues, what's missing here?
Comment #9
ergonlogicWhile docs can always use improvement, I think this particular issue is done.