Updated Documentation.

aws · Feb 18, 2015 · 9692e33 · 9692e33
1 parent 8f674dd
commit 9692e33
Show file tree

Hide file tree

Showing 9 changed files with 525 additions and 31 deletions.
diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
diff --git a/docs/source/functional.rst b/docs/source/functional.rst
@@ -0,0 +1,11 @@
+.. _functional
+
+How cfncluster Works
+####################
+
+cfncluster was built not only as a way to manage clusters, but as a reference on how to use AWS services to build your HPC environment
+
+.. toctree::
+
+    aws_services
+    autoscaling    
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,21 +4,18 @@
    contain the root `toctree` directive.
 
 
-Welcome to cfncluster's documentation!
-======================================
+cfncluster
+##########
 
-.. toctree::
-   :hidden:
+cfncluster is a framework that deploys and maintains High Performance Clusters (HPC) on AWS. It is reasonably agnostic to what the cluster is for and can easily be extended to support different frameworks. The CLI is stateless, everything is done using CloudFormation or resources within AWS.
 
-   getting_started
-   networking
-   aws_services
-   autoscaling
-   pre_post_install
-   s3_resources
-   toc
+.. toctree::
+    :maxdepth: 2
 
-cfncluster is a framework that deploys and maintains HPC clusters on AWS. It is reasonably agnostic to what the cluster is for and can easily be extended to support different frameworks. The CLI is stateless, everything is done using CloudFormation or resources within AWS.
+    getting_started
+    welcome
+    configuration
+    functional    
 
 Getting Started
 ---------------
@@ -50,4 +47,3 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`search`
-* :ref:`toc`
diff --git a/docs/source/networking.rst b/docs/source/networking.rst
@@ -1,7 +1,7 @@
 .. _networking:
 
-cfncluster Networking Configurations
-====================================
+Network Configurations
+======================
 
 cfncluster leverages Amazon Virtual Private Cloud(VPC) for networking. This provides a very flexiable and configurable networking platform to deploy clusters within. cfncluster support the following high-level configurations:
 

diff --git a/docs/source/pre_post_install.rst b/docs/source/pre_post_install.rst
@@ -1,7 +1,7 @@
 .. _pre_post_install:
 
-Pre & Post Install Actions
-==========================
+Custom Bootstrap Actions
+========================
 
 cfncluster can execute arbritary code either before(pre) or after(post) the main bootstrap action during cluster creation. This code is typically stored in S3 and accessed via HTTP(S) during cluster creation. The code will be executed as root and can be in any script language supppoted by the cluster OS, typically `bash` or `python`. 
 

diff --git a/docs/source/s3_resources.rst b/docs/source/s3_resources.rst
@@ -1,6 +1,6 @@
 .. _s3_resources:
 
-working with S3
+Working with S3
 ===============
 
 Accessing S3 within cfncluster can be controlled through two parameters in the cfncluster config.

diff --git a/docs/source/toc.rst b/docs/source/toc.rst
diff --git a/docs/source/welcome.rst b/docs/source/welcome.rst
@@ -0,0 +1,10 @@
+.. _welcome
+
+Working with cfncluster
+#######################
+
+.. toctree::
+
+    networking
+    pre_post_install
+    s3_resources
diff --git a/docs/staging/first_job.rst b/docs/staging/first_job.rst
@@ -0,0 +1,11 @@
+Running your first job
+######################
+
+
+- Run through getting started to create your cluster
+- SSH to master node
+- Download source
+- Compile
+- Create job file
+- Submit job
+- View output