Improved docs, changed from git clone to the updater script in quick …

…start
riotkit-org · Mar 13, 2019 · dea92f0 · dea92f0
1 parent d0d440e
commit dea92f0
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,7 @@
 /.idea
+/.vscode
+/docs/build
+/docs/source/_build
 /data/*/
 !/data/*/.gitkeep
 /data/www-data/*

diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 Docker Project Template
 =======================
 
+[![Documentation Status](https://readthedocs.org/projects/riotkit-docker-template/badge/?version=latest)](https://environment.docs.riotkit.org/en/latest/?badge=latest)
+
 docker-compose + git based template which features a complete infrastructure for any project.
 
 Includes:

diff --git a/docs/source/configuration_reference.rst b/docs/source/configuration_reference.rst
@@ -0,0 +1,8 @@
+.. _configuration_reference:
+
+Configuration reference
+=======================
+
+.. literalinclude:: ../../.env-default
+   :language: bash
+
diff --git a/docs/source/first-steps.rst b/docs/source/first-steps.rst
@@ -18,14 +18,20 @@ Project template is hosted on **git** version control system and it's updater ba
 
 .. code:: bash
 
-    git clone https://git.riotkit.org/docker-project-template your-project-name
-    cd your-project-name
+    mkdir your-project-dir
+    cd your-project-dir
+
+    # initialize git repository, at least locally
+    git init
+
+    # download the project files using updater script
+    curl -s https://raw.githubusercontent.com/zwiazeksyndykalistowpolski/docker-project-template/master/update-from-template.sh | bash
 
 2. Take a look around, check documentation for:
 
 - :ref:`structure`
 - :ref:`features`
-- Configuration reference
+- :ref:`configuration_reference`
 
 3. Configure the project:
 

diff --git a/docs/source/general_concept.rst b/docs/source/general_concept.rst
@@ -66,7 +66,7 @@ As the **.env** cannot be pushed into the repository, there is a possibility to
 Main domain and domain suffix concept
 -------------------------------------
 
-**MAIN_DOMAIN** can be defined in **.env** and reused in YAML files togeter with **DOMAIN_SUFFIX**.
+**MAIN_DOMAIN** can be defined in **.env** and reused in YAML files together with **DOMAIN_SUFFIX**.
 It opens huge possibility of creating test environments which have different DNS settings.
 Sounds like a theory? Let's see a practical example!