Skip to content

Commit

Permalink
update index, push, before rewriting sphinx info
Browse files Browse the repository at this point in the history
  • Loading branch information
garlovel committed Nov 29, 2012
1 parent a06d455 commit e9a346b
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 27 deletions.
29 changes: 29 additions & 0 deletions 05_other.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. _setup_other:

#############################
Other Accounts
#############################

.. note:: The cloud service accounts installed perviously will be used right
away. This article describes additional services which will be used somewhat
later, and which are not required for the basic exercises to follow.

Dropbox and Google Documents
=============================

Some project information does not fit in nicely with the text documents that
software developers write. Graphic images, video, and drawing or design files
might be used in a project by the design team. Software developers need access
to these files, even though these data are usually not stored in a repository,
and file sharing services answer this need.

(Instructions to be added later.)

Asana Project Management
=============================

Project management is an important aspect of collaborative development,
especially regarding client input and relationships. Setup an Asana account to
track development issues and progress.

(Instructions to be added later.)
33 changes: 22 additions & 11 deletions 08_use-documents.rst → 08_use-sphinxdoc.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
.. _use_documents:
.. _use_sphinxdoc:

#############################
Sample Documentation
Documentation Sample Project
#############################

This sample will create a new documentation project for a student Journal.
This exercise will create a new documentation project for a student Journal.

In GitHub Account
Create a Project Workspace
=============================

In Your GitHub Account
-----------------------------

Create a new repository in GitHub, naming it :file:`doc-journal`.
Expand All @@ -15,7 +18,7 @@ Create a new repository in GitHub, naming it :file:`doc-journal`.
+ Do not add a :file:`.gitignore` now.
+ Click :guilabel:`create repository`.

In Cloud9 Account
In Your Cloud9 Account
-----------------------------

+ At the top of the left menu, click on :guilabel:`Your Account`.
Expand All @@ -25,7 +28,7 @@ In Cloud9 Account
+ In the :guilabel:`Clone from URL` dialog, click button :guilabel:`CREATE`.
+ Click the :guilabel:`START EDITING` button to open your project workspace.

Cloud9 Project Workspace
Install Sphinxdoc in Cloud9
-----------------------------

Sphinxdoc documenation tools are installed using python package manager
Expand All @@ -36,20 +39,28 @@ Sphinxdoc documenation tools are installed using python package manager
Download Files to Include
-----------------------------

We wish to include a series of files in this project:
We wish to include some files in this project which are downloadable from the
following links:

+ :download:`gitignore for Sphinx projects <_downloads/.gitignore>`
+ :download:`Adding documentation to a code project <_downloads/docbranch-add.sh>`
+ :download:`Starting a documentation project <_downloads/docproject-start.sh>`
+ :download:`Deploy documentation to GitHub gh-pages <_downloads/github-deploy.sh>`

The web browser downloads files to a local device, not to the Cloud9 workspace.
The Linux :command:`wget` command can return these files to Cloud9::
Now here is the problem: the web browser downloads files to a local device, not
to the Cloud9 workspace. To return files to Cloud9, use the Linux
:command:`wget` command instead. Copy and paste the following commands into the
console command line::

wget http://vstem-davenport.github.com/doc-devcloud/_downloads/.gitignore
wget http://vstem-davenport.github.com/doc-devcloud/_downloads/docbranch-add.sh
wget http://vstem-davenport.github.com/doc-devcloud/_downloads/docproject-start.sh
wget http://vstem-davenport.github.com/doc-devcloud/_downloads/github-deploy.sh

After getting the files, click the :guilabel:`gear icon` on top of the left
sidebar, and choose :guilabel:`Refresh Project Tree`.
sidebar, and choose :guilabel:`Refresh Project Tree` to see the additions.

Initialize Sphinxdoc
=============================



30 changes: 14 additions & 16 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,22 @@
Welcome to Cloud Development's documentation!
=============================================

:ref:`Introduction to Cloud Development <introduction>`.

#. Topic 1: :ref:`Setting up an account on Google Gmail <setup_gmail>`.
#. Topic 2: :ref:`Setting up an account on GitHub <setup_github>`.
#. Topic 3: :ref:`Setting up an account on Heroku <setup_heroku>`.
#. Topic 4: :ref:`Setting up an account on Cloud9 <setup_cloud9>`.

#. Topic 6: :ref:`Creating a repository at GitHub <use_github>`.
#. Topic 7: :ref:`Using Cloud9 for web development <use_cloud9>`.
#. Topic 8: :ref:`Publishing on GitHub with Restructured Text <use_documents>`.
#. Topic 9: :ref:`Deploying an application to Heroku <use_heroku>`.


Table of Contents:
====================
| :ref:`Introduction to Cloud Development <introduction>`.
| :ref:`Topic 1: Setting up a Google Gmail account <setup_gmail>`.
| :ref:`Topic 2: Setting up a GitHub account <setup_github>`.
| :ref:`Topic 3: Setting up a Heroku account <setup_heroku>`.
| :ref:`Topic 4: Setting up a Cloud9 account <setup_cloud9>`.
| :ref:`Topic 5: Setting up other accounts <setup_other>`.
| :ref:`Topic 6: Creating a repository at GitHub <use_github>`.
| :ref:`Topic 7: Using Cloud9 for web development <use_cloud9>`.
| :ref:`Topic 8: Publishing Sphinxdocs on GitHub <use_sphinxdoc>`.
| :ref:`Topic 9: Deploying a Rails App to Heroku <use_heroku>`.
----------

.. toctree::
:numbered:
:maxdepth: 2
:glob:

[0-9]*

0 comments on commit e9a346b

Please sign in to comment.