From eb824df2e451ee85f68a09974204f01c8c03ee4e Mon Sep 17 00:00:00 2001 From: lanefu Date: Mon, 4 Jul 2016 15:06:01 -0400 Subject: [PATCH] updated contribute process per Tidos request.. added quick documentation markdown template --- docs/Process_Contribute.md | 26 +++++++++++++---- templates/Example_Documentation-template.md | 31 +++++++++++++++++++++ 2 files changed, 51 insertions(+), 6 deletions(-) create mode 100644 templates/Example_Documentation-template.md diff --git a/docs/Process_Contribute.md b/docs/Process_Contribute.md index edfdadd0..8fad6acd 100644 --- a/docs/Process_Contribute.md +++ b/docs/Process_Contribute.md @@ -1,16 +1,16 @@ # Collaborate on the project # -**How?** +## How? ## 1. [Fork](http://help.github.com/forking/) the project -2. Make one or more well commented and clean commits to the repository. -3. Perform a [pull request](http://help.github.com/pull-requests/) in github's web interface. +1. Make one or more well commented and clean commits to the repository. +1. Perform a [pull request](http://help.github.com/pull-requests/) in github's web interface. If it is a new feature request, don't start the coding first. Remember to [open an issue](https://guides.github.com/features/issues/) to discuss the new feature. If you are struggling, check [this detailed step by step guide on contributing](https://www.exchangecore.com/blog/contributing-concrete5-github/). -**Where are sources?** +## Where are sources? ## Build script: @@ -18,7 +18,21 @@ Build script: Manual: - https://github.com/igorpecovnik/lib.wiki + http://docs.armbian.com + +# Collaborate with Documentation # + +## Documentation Workflow ## + +1. Contributor clones repo `git@github.com:igorpecovnik/lib.docs.git` +1. Contributor copies ex: `templates/howto_template.md` to `docs/howto_new-topic.md` +1. Contributor creates content within the simple framework provided by template +1. Contributor commits and pushes to repo +1. post-commit job runs a more intelligent version of `tools/mkArmbianDocs.py` and generates new mkdocs.yml +1. post-commit builds new docs site, pushes, builds PDF (maybe--unless extra curation is desired) +1. Contributor is delighted that creating a single markdown file was all that was needed to impact the community +1. Contributor is inspired to create more content -- because it was soooooo easy. + # Help with donations # @@ -26,4 +40,4 @@ If you find our project useful, then we’d really appreciate it if you’d cons http://www.armbian.com/donate/ -Thanks! \ No newline at end of file +Thanks! diff --git a/templates/Example_Documentation-template.md b/templates/Example_Documentation-template.md new file mode 100644 index 00000000..b9396150 --- /dev/null +++ b/templates/Example_Documentation-template.md @@ -0,0 +1,31 @@ +# Topic # + +## Overview ## + +A brief summary goes here. Two or three sentences + +Optional Bullet Points for Clarity: +* does this +* does that +* does hte other + +## Component 1 ## + +### Subcomponent 2 ### + +### Subcomponent 2 + +## Component 2 ## + +## Step-by-Step Procedure ## + +1, step +1. step +1. step +1. step + +## Resources ## + +[hyperlink to code](http://example.com) +[hyperlink to other documentation](http://example.com) +[hyperlink to discussion](http://example.com)