thegooddocsproject / templates

Templates created by The Good Docs Project - for all your tech writing needs.
https://thegooddocsproject.dev/
Other
680 stars 170 forks source link

Convert adoc templates to markdown #164

Open Loquacity opened 4 years ago

Loquacity commented 4 years ago

These templates don't adhere to the same format used in the markdown templates. Most of the markdown templates are bare bones, with the discussion and reasoning in their companion doc, while the adoc templates have more content in the template file. Additionally, the adoc files have a certain amount of variables, etc, that only work within an adoc environment.

This issue is to track the work of converting these three templates into markdown, and bringing their content in line structurally with the other templates in the repo.

camerons commented 3 years ago

This would be a good first issue for someone interested starting to join our project. I'd suggest start first by initially just doing a conversion of current text, and getting that accepted.

Later you can discuss changing the structure of the documents. (There might be a base template to work from by the time you do this second update phase.)