Merge pull request #32 from CiscoCloud/documentation

Documentation

shipped-bootstrap-project/src/posts/files/shipped-bootstrap-project/1.md

@@ -1,6 +1,6 @@
 # Shipped - Bootstrap a Project #
 
-
+Bootstrapping loads the project files onto your local computer and initializes the project.
 
 
 
@@ -16,7 +16,7 @@ You will learn how to:
 
 ## Prerequisites ##
 
-- Managing Services
+- *Managing Services*
 
 
 

shipped-deploy-project/src/posts/files/shipped-deploy-project/1.md

@@ -15,7 +15,7 @@ You will learn how to:
 
 ##Prerequisites
 
-- Managing Environments
+- *Managing Environments*
 
 
 
@@ -36,7 +36,11 @@ You can open these references in a separate tab and refer to them during this La
 
 1. From the Deploy tab, select the environment you want to deploy, then click **Deploy Build**.
 
-2. 
+	The status window shows up, letting you know how the deployment is progressing. This might take a few minutes.
+
+2. If successful, you can deploy your build to an environment. See *Managing Environments*.
+
+	If not successful, an error message appears telling you what to do next.
 
 
 

shipped-manage-environments/src/posts/files/shipped-manage-environments/1.md

@@ -25,7 +25,7 @@ You will learn how to:
 
 ##Prerequisites
 
-- Bootstrap a Project
+- *Bootstrap a Project*
 
 
 ##References
@@ -44,11 +44,11 @@ You can open these references in a separate tab and refer to them during this La
 ##Create an Environment using the UI
 
 
-1. From the *Deploy* tab, click *Create a new environment*.
+1. From the **Deploy** tab, click **Create a new environment**.
 
-	The *New Environment* window opens.
+	The **New Environment** window opens.
 
-2. Type the name of your environment and a brief description (optional), then click *Add Environment*.
+2. Type the name of your environment and a brief description (optional), then click **Add Environment**.
 
 
 

shipped-manage-environments/src/posts/files/shipped-manage-environments/2.md

@@ -19,7 +19,7 @@ Successful builds will now automatically deploy to this environment.
 
 ## Set the Default Environment using the API
 
-The default environment can't be set using the API.
+This feature has not been implemented.
 
 
 

shipped-manage-projects/src/posts/files/shipped-manage-projects/1.md

@@ -49,8 +49,9 @@ You can open these references in a separate tab and refer to them during this La
 
 	Shipped builds some basic components, then shows the **Compose Your Project** page.
 
+	<img src="assets/compose-your-project.png">
 	![](posts/files/shipped-manage-projects/assets/compose-your-project.png)
-	<img src="assets/compose-your-project.png" border="1">
+
 
 
 3. Click **Start from a Buildpack**, then select **Dropwizard**.

shipped-manage-projects/src/posts/files/shipped-manage-projects/2.md

@@ -6,7 +6,18 @@ You can change the description or name of a project.
 
 ##Modify a Project using the UI
 
+You can change the Project Name.
 
+1. Select the Project you want to update, then click the Project tab.
+
+	The **Compose Your Project** page appears.
+
+2. Click the Project name, then make the change you want.
+
+	<img src="assets/modify-project.png">
+	![](posts/files/shipped-manage-project/assets/modify-project.png)
+
+3. Tab out of the field or click anywhere on the page. The project now has a new name.
 
 
 

shipped-manage-projects/src/posts/files/shipped-manage-projects/4.md

@@ -7,9 +7,23 @@ Deleting a Project is permanent and can't be undone, although you can always cre
 
 ## Delete a Project using the UI
 
+Deleting a Project is permanent and can't be undone.
+
+1. Click **Settings**, the select the **Options** tab.
+
+	<img src="assets/delete-project.png">
+	 ![](posts/files/shipped-manage-projects/assets/delete-project.png)
+
+2. Click **Delete**.
+
+	The delete confirmation window opens.
 
+3. Enter the name of the project in the text box, then click **Delete Project**.
 
+	<img src="assets/delete-project-confirm.png">
+	 ![](posts/files/shipped-manage-projects/assets/delete-project-confirm.png)
 
+	The project has now been removed and no longer appears on the project list.
 
 
 ## Delete a Project using the API

shipped-manage-users/src/posts/files/shipped-manage-users/1.md

@@ -2,6 +2,7 @@
 A User is anyone with access to the deployed project. When you create a project, you are automatically designated a User, although you are the only one. You can add as many users as you want.
 
 
+Add users by sending an Invite Token, which they receive by email. When they respond, Shipped  automatically adds them as users.
 
 ##Objectives
 Completion time: 15 minutes
@@ -17,7 +18,7 @@ You will learn how to:
 ##Prerequisites
 
 - You must have built and deployed a project.
-
+- See *Bootstrap a Project*.
 
 
 ##References
@@ -35,24 +36,50 @@ You can open these references in a separate tab and refer to them during this La
 <a name="create"></a>
 ## Add a User using the UI
 
-You can add new users in the UI.
 
-1. 1. Click **Settings**, then select the **Collaborators** tab.
+1. Click **Settings**, then select the **Collaborators** tab.
+
+	<img src="assets/create-users.png">
+	![](posts/files/shipped-manage-users/assets/create-users.png)
+
 2. Click **Add New User**.
-4. Enter the user email addresses. You can enter as many email addresses as you need.
+
+	The Add Users window opens.
+
+	<img src="assets/invite-users.png">
+	![](posts/files/shipped-manage-users/assets/invite-users.png)
+
+4. Enter user email addresses. You can enter as many email addresses as you need.
 5. Click **Invite Users**.
 
-Emails are sent to each user with a unique token number enabling them to log into the Project.
+Emails are sent to each user with unique token numbers. When they respond, they are then able to log into the project.
 
 
 ## Add a User using the API
 
+You can create an invite token for single or multiple email addresses. This endpoint sends the invites to these addresses.
 
+	curl 'https://api.ciscoshipped.io/invite_tokens' -H 'Content-Type: application/json' -d '{"project_id":"34a35726-66e9-11e5-99df-0242ac110120","emails":["[email protected]"]}'
 
 
-## Add a User using the CLI
+HTTP Request:
+
+	POST https://api.ciscoshipped.io/invite_tokens
 
 
+Shipped accepts an invite by resolving an invite token. If authenticated, Shipped adds the current user to the project; otherwise,  instructs the client to redirect to the authentication view.
+
+	curl 'https://api.ciscoshipped.io/invite_tokens/c490939f-66ff-11e5-9de2-0242ac110121'
+
+
+HTTP Request:
+
+	GET https://api.ciscoshipped.io/invite_tokens/<INVITE_TOKEN>
+
+
+## Add a User using the CLI
+
+This feature has not yet been  implemented.
 
 
 

shipped-manage-users/src/posts/files/shipped-manage-users/2.md

@@ -13,7 +13,22 @@ You can delete a user using the:
 <a name="ui"></a>
 ## Delete a User using the UI
 
+1. Click **Settings**, then select the **Collaborators** tab.
 
+	The users list is shown.
+
+2. Select a user. The user details box comes up.
+
+	<img src="assets/user-details.png">
+	![](posts/files/shipped-manage-users/assets/user-details.png)
+
+3. Click **Remove this user from the project**.
+
+	The delete user confirmation message shows up.
+
+4. Click **Remove User**.
+
+	The user no longer has access to the project.
 
 
 

shipped-manage-users/src/posts/files/shipped-manage-users/3.md

@@ -12,7 +12,7 @@ You can retrieve a list of users that have access to the project, or retrieve th
 
 	The users appear.
 
-2. Users who have had an Invite Token sent appear as *Invited*.
+2. Users who have been sent an Invite Token appear as *Invited*.
 
 	When they have accepted the invite, they appear as *Collaborator*.