Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated docs to reflect GH auth support in cli setup #805

Merged
merged 1 commit into from
Jun 14, 2016
Merged

Updated docs to reflect GH auth support in cli setup #805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion www/source/docs/create-plans.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ To create a plan, do the following:

2. All plans must have a `plan.sh` at the root of the plan context. This file will be used by the hab-plan-build command to build your package, so create a plan.sh file in your plan context and open it.

touch plan.sh && $EDITOR plan.sh
$EDITOR plan.sh

3. Copy the following template into plan.sh. You can use it as a skeleton template when writing new plans.

Expand Down
2 changes: 1 addition & 1 deletion www/source/docs/share-packages-overview.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ We will use the public depot provided by the Habitat project for this section. H

## Creating an account in the depot

The depot software presently only supports GitHub authentication. For the public depot, you visit https://app.habitat.sh/ in your browser and sign up for an account, allowing it to use GitHub for authorization.
The depot software presently only supports GitHub authentication. For the public depot, visit https://app.habitat.sh/ in your browser and sign up for an account. Allow it to use GitHub for authorization.

## Creating an origin or joining an existing origin

Expand Down
4 changes: 2 additions & 2 deletions www/source/shared/_setup_environment.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ The `hab` command-line interface (CLI) tool downloads its other components when
docker-machine start
eval "$(docker-machine env machinename)"

5. Follow the instructions in the setup script. Create a new origin and a set of origin keys. If you would like to provide anonymous data on your usage of the `hab` CLI, please type in `Yes` or hit Enter. For information on the type of data we gather and how we intend to use it, see [Analytics in Habitat](/docs/about-analytics).
5. Follow the instructions in the setup script. Create a new origin and a set of origin keys. Optionally, you can provide a [GitHub personal authorization token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) for the `hab` CLI to use to upload packages to the public depot and share them with the Habitat community. You can also provide anonymous data on your usage of the `hab` CLI. For information on the type of data we gather and how we intend to use it, see [Analytics in Habitat](/docs/about-analytics).

> Note: You can also opt-out of providing usage data at a later point in time by re-running the `hab setup` subcommand and typing `No` when asked if you want to provide usage data.
> Note: The only rights the GitHub personal authorization token needs at present is `user.email` since it is only used for authentication. Also, you can opt-out of providing usage data at a later point in time by re-running the `hab setup` subcommand and typing `No` when asked if you want to provide usage data.
2 changes: 1 addition & 1 deletion www/source/tutorials/getting-started-overview.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ As a first step in understanding Habitat, this tutorial will show you how to cre
This tutorial currently supports Linux and Mac OS X as host operating systems. Before starting this tutorial, you need to have the following:

* The `hab` command-line interface tool. See [Get Habitat](/docs/get-habitat) if you don't already have this installed on your machine.
{::comment}* An active GitHub account is recommended. If you don't already have an account, [sign up](https://github.com/) for one now. Note: This is only required if you want to use the build service to build your packages. {:/comment}
* An active GitHub account is recommended. If you don't already have an account, [sign up](https://github.com/) for one now. Note: This is required to upload and share your packages with others in the Habitat community.
* Your favorite text editor.
* Open egress on TCP port 9636. This is needed to upload and download packages from the public depot.
* If you are running Mac OS X on your host machine, then you need [Docker Toolbox](https://www.docker.com/products/docker-toolbox) installed. The toolbox also installs Oracle VM VirtualBox, which will run and manage the Linux VM where the Docker daemon resides. Make sure you have a Docker VM running before proceeding through the tutorial.
Expand Down