From 3791633ea46786acce7671dd9078ef1d2e6734fc Mon Sep 17 00:00:00 2001
From: Gregory Kurtzer <gmkurtzer@gmail.com>
Date: Tue, 22 Dec 2020 22:26:29 -0800
Subject: [PATCH] Setting up basic documentation

---
 docs/Contributing.md     | 23 +++++++++++++++++++++++
 docs/README.md           | 14 ++++++++++++++
 docs/rhel7-quickstart.md |  2 +-
 docs/rhel8-quickstart.md |  2 +-
 4 files changed, 39 insertions(+), 2 deletions(-)
 create mode 100644 docs/Contributing.md

diff --git a/docs/Contributing.md b/docs/Contributing.md
new file mode 100644
index 00000000..29bd092e
--- /dev/null
+++ b/docs/Contributing.md
@@ -0,0 +1,23 @@
+# Contributing
+
+Warewulf is an open source project and we invite your collaboration and help.
+
+## Contributor's Agreement
+You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality 
+or performance of the source code ("Enhancements") to anyone; however, if you choose to make your Enhancements 
+available either publicly, or directly to the project, without imposing a separate written license agreement for such
+Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to 
+install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense
+such enhancements or derivative works thereof, in binary and source code form.
+
+## To Contribute
+Here is the very high level guide to contributing:
+
+* For the project to a location of your choosing
+* Clone your fork locally: `git clone http://github.com/$NAME/warewulf.git`
+* Inside your fork, create a local branch: `cd warewulf; git checkout -b localchanges`
+* Make the necessary changes and commit them: `git commit -a`
+* Push your changes: `git push origin localchanges`
+* Create a PR using GitHub: `https://github.com/$NAME/warewulf/pull/new/localchanges`
+
+*note: set your environment variable `NAME=github_username` before running the above commands.*
diff --git a/docs/README.md b/docs/README.md
index 7226386a..2ccdeaa2 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,7 +1,21 @@
 # Documentation for Warewulf
 
+The documentation for Warewulf is a work in progress and we are asking for contributions from the open source 
+community on this. Please see the [contributing](Contributing.md) document for how to help out this project.
+
 ### Quickstarts
 
 * [RHEL-7 quickstart](rhel7-quickstart.md)
 * [RHEL-8 quickstart](rhel8-quickstart.md)
 
+### Chapters
+(all coming soon)
+
+* [Introduction](introduction.md)
+* [Architecture](architecture.md)
+* [System Services and Dependencies](system_services.md)
+* [Profiles](profiles.md)
+* [Node Configurations](nodes.md)
+* [Containers and VNFS images](containers.md)
+* [Overlays](overlays.md)
+* [SELinux](selinux.md)
diff --git a/docs/rhel7-quickstart.md b/docs/rhel7-quickstart.md
index 24f8c114..aaf02d5e 100644
--- a/docs/rhel7-quickstart.md
+++ b/docs/rhel7-quickstart.md
@@ -128,7 +128,7 @@ Here are some of the common `overlay` commands:
 ```
 sudo ./wwctl overlay list -l
 sudo ./wwctl overlay list -ls
-sudo EDITOR=vim ./wwctl overlay edit default /etc/hello_world.ww
+sudo ./wwctl overlay edit default /etc/hello_world.ww
 sudo ./wwctl overlay build -a
 ```
 
diff --git a/docs/rhel8-quickstart.md b/docs/rhel8-quickstart.md
index 1acfb887..1b255256 100644
--- a/docs/rhel8-quickstart.md
+++ b/docs/rhel8-quickstart.md
@@ -129,7 +129,7 @@ Here are some of the common `overlay` commands:
 ```
 sudo ./wwctl overlay list -l
 sudo ./wwctl overlay list -ls
-sudo EDITOR=vim ./wwctl overlay edit default /etc/hello_world.ww
+sudo ./wwctl overlay edit default /etc/hello_world.ww
 sudo ./wwctl overlay build -a
 ```