Contribution Guide for Atomic Host Documentation

Signed-off-by: Trishna Guha <[email protected]>

Author: trishnaguha

README.md

@@ -1,13 +1,17 @@
 # atomic-host-docs
 
-This repository includes the ASCIIbinder with documentation for Atomic Host, including both Fedora Atomic Host and CentOS Atomic Host.
+This repository includes the [AsciiBinder](http://www.asciibinder.org) with documentation for Atomic Host, including both Fedora Atomic Host and CentOS Atomic Host.
 
-Additional information about how to build the documentation and its contents will here once we figure them out.
+Additional information about how to build the documentation is here: [Contribution-Guide](https://github.com/projectatomic/atomic-host-docs#contribution-guide).
 
 ## Attic
 
 The "attic" contains contributed files from other sources such as Red Hat Atomic Host documentation, the ProjectAtomic blog, and other sources.  These are awaiting conversion into final documentation form.
 
+## Contribution Guide
+
+Want to hack on Atomic Host Docs? Check the [Contribution-Guide](https://github.com/projectatomic/atomic-host-docs/blob/master/atomic-host-guide/contribution_guide.adoc).
+
 ## Copyright and Contributors
 
 This documentation is copyright 2016-2017 Red Hat Inc., and repository contributors.  It is licensed Creative Commons Share-Alike 4.0; see included LICENSE file for details.

_topic_map.yml

@@ -40,3 +40,10 @@ Topics:
       File: installing_cockpit
     - Name: How to Use
       File: using_cockpit
+
+---
+Name: Contribute Guide
+Dir: atomic-host-guide
+Topics:
+  - Name: How Can I Contribute
+    File: contribution_guide

atomic-host-guide/contribution_guide.adoc

@@ -0,0 +1,89 @@
+[contribution-guide]
+= {product-title} Documentation Contribution Guide
+{product-author}
+{product-version}
+:data-uri:
+:icons:
+:imagesdir: {images}
+
+[.lead]
+link:http://www.projectatomic.io[Project Atomic] aims to build a welcoming and diverse community. 
+{product-title} Documentation focuses on convering Docs required for {product-title} introduction 
+to how to compose, manage and deploy {product-title} and its various application.
+
+
+=== Requirements
+
+* link:http://asciidoctor.org/docs/what-is-asciidoc/#what-is-asciidoc[AsciiDoc] markup language to write Docs.
+* link:http://asciidoctor.org[Asciidoctor] that acts as text processor to convert AsciiDoc content to HTML5, DocBook and others.
+* link:http://www.asciibinder.org[AsciiBinder] that helps to build, maintain documentation in easier way.
+
+
+=== Set up Development Environment
+
+....
+$ sudo dnf install ansible
+$ git clone https://github.com/projectatomic/atomic-host-docs.git
+$ git checkout -b <branch-name>
+$ cd atomic-host-docs
+$ ansible-playbook setup.yml --ask-sudo-pass
+....
+
+
+=== How to Write Doc
+
+{product-title} Documentation uses AsciiDoc markup language. You can have a look at the 
+link:http://asciidoctor.org/docs/asciidoc-syntax-quick-reference[Reference] for AsciiDoc Syntax.
+
+....
+$ mkdir atomic-host-guide/container && touch atomic-host-guide/container/overview.adoc
+....
+
+.atomic-host-guide/container/overview.adoc
+----
+[[container-overview]]
+= Container Overview
+{product-author}
+{product-version}
+:data-uri:
+:icons:
+
+Container contains applications in a way to keep itself isolated from the host system that it runs on and 
+container allows developer to package an application with all of it parts, such as libraries and other packages
+it needs to run and ship it all as one package.
+I love Containers!!!
+----
+
+After the Doc is ready, we need to make entry in `_topic_map.yml` file. 
+This file tells AsciiBinder which *_topic_* groups and *_topics_* to generate.
+
+._topic_map.yml
+----
+---
+Name: Tools
+Dir: atomic-host-guide
+Topics:
+  - Name: Containers
+    Dir: container
+    Topics:
+    - Name: Overview
+      File: overview
+----
+
+Now go to the root directory of the repo. The following command will build the Documentation.
+....
+$ asciibinder
+....
+
+
+=== Verify
+
+A new directory will be created named `_preview`. You will be able to browse Documentation from there that you just build.
+
+This is how it will look like after the Doc is build:
+
+image::contribution-guide-demo.png[alt="Sunset", width="900", height="500"]
+=== Join the Community
+
+If you are interested joining the Project Atomic community, please refer to 
+link:http://www.projectatomic.io/community[Project-Atomic-Community].

atomic-host-guide/images/contribution-guide-demo.png

@@ -0,0 +1,23 @@
+---
+- name: Setup Development Environment
+  hosts: localhost
+  become: yes
+  become_method: sudo
+
+  tasks:
+    - name: Install the list of required packages
+      package: name={{ item }} state=installed
+      with_items:
+      - gcc
+      - gcc-c++
+      - java-1.8.0-openjdk
+      - java-1.8.0-openjdk-devel
+      - ruby
+      - rubygems
+      - ruby-devel
+      - redhat-rpm-config
+      - asciidoc
+      - asciidoctor
+
+    - name: Install AsciiBinder
+      shell: gem install ascii_binder