Skip to content

Commit 89cf52d

Browse files
authored
Merge pull request #316 from alexlafroscia/fix-public-key-name
fix(docs): use correct public key name
2 parents 9e1e088 + 30fd72e commit 89cf52d

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

tests/dummy/app/pods/docs/deploying/template.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Once everything is set up, you'll be able to visit <u>https://**[user]**.github.
88

99
To deploy your docs site to GitHub pages, you'll need to go through a few steps of first-time setup:
1010

11-
1. Run `ember g ember-cli-addon-docs` to set up the relevant deploy plugins (this is done automatically if you used `ember install` to install Addon Docs)
12-
2. Set [the `repository` field](https://docs.npmjs.com/files/package.json#repository) of your `package.json`.
13-
3. Commit any outstanding changes you've got on your current branch and push them to GitHub.
14-
4. Run `ember deploy production` and answer "yes" if prompted to create a `gh-pages` branch. **Note**: if your repo already has a `gh-pages` branch, you may want to manually archive the existing content there before deploying.
11+
1. Run `ember g ember-cli-addon-docs` to set up the relevant deploy plugins (this is done automatically if you used `ember install` to install Addon Docs)
12+
2. Set [the `repository` field](https://docs.npmjs.com/files/package.json#repository) of your `package.json`.
13+
3. Commit any outstanding changes you've got on your current branch and push them to GitHub.
14+
4. Run `ember deploy production` and answer "yes" if prompted to create a `gh-pages` branch. **Note**: if your repo already has a `gh-pages` branch, you may want to manually archive the existing content there before deploying.
1515

1616
Once the deploy completes and GitHub has a moment to publish your pages site, if all went well you should see your addon's dummy app live at
1717
<u>https://**[user]**.github.io/**[repo]**/versions/**[current-branch]**</u>.
@@ -29,9 +29,10 @@ Now take a look at the `gh-pages` branch either locally or on GitHub. You should
2929
```
3030

3131
Let's break down what each of those items is doing.
32-
- `404.html` contains [some smart redirect logic](https://github.com/rafrex/spa-github-pages) to keep you from having to use `locationType: 'hash'` in your dummy app
33-
- `versions.json` contains a manifest of the available versions of your documentation
34-
- `versions/[current-branch]` contains all the files from your built docs app
32+
33+
- `404.html` contains [some smart redirect logic](https://github.com/rafrex/spa-github-pages) to keep you from having to use `locationType: 'hash'` in your dummy app
34+
- `versions.json` contains a manifest of the available versions of your documentation
35+
- `versions/[current-branch]` contains all the files from your built docs app
3536

3637
If you were to make a change to your dummy app and run `ember deploy production` again right now, the entry for `[current-branch]` in `versions.json` and the entire contents of the `versions/[current-branch]` directory would be replaced with the updated version of your site. Next we'll talk about how to manage keeping published documentation around for multiple versions of your addon.
3738

@@ -43,7 +44,7 @@ Whenever you deploy your documentation site with Addon Docs, it places the compi
4344

4445
When you run `ember deploy` at a commit that has a git tag associated with it, the app will wind up in a directory named after that tag. For example, if you've just published version 1.2.3 of your addon (creating tag `v1.2.3` in your git repository), your deployed site will be available at <u>https://**[user]**.github.io/**[repo]**/versions/v1.2.3</u>.
4546

46-
By default, deploying from a tagged commit also places a copy of your app at the root of your `gh-pages` branch, so <u>https://**[user]**.github.io/**[repo]**</u> will always bring developers to the documentation for the most recent stable release of your addon. If you deploy without a tagged release, <u>https://**[user]**.github.io/**[repo]**</u> will return a 404.
47+
By default, deploying from a tagged commit also places a copy of your app at the root of your `gh-pages` branch, so <u>https://**[user]**.github.io/**[repo]**</u> will always bring developers to the documentation for the most recent stable release of your addon. If you deploy without a tagged release, <u>https://**[user]**.github.io/**[repo]**</u> will return a 404.
4748

4849
Note that this only applies to non-prerelease tags, so `v1.2.3` would update the root app, but `v2.0.0-beta.1` would not. Check out the documentation for [node-semver](https://github.com/npm/node-semver) for the exact details on what constitutes a prerelease version.
4950

@@ -73,7 +74,7 @@ This will produce two files in your current directory: `deploy_key` (the private
7374

7475
On GitHub, open the page for your repo and navigate to _Settings_ -> _Deploy keys_ (or just directly visit <u>https://github.com/**[user]**/**[repo]**/settings/keys)</u> and click "Add deploy key".
7576

76-
Enter a name for your key and then paste the contents of your public key (`id_rsa.pub`) into the big textarea. Make sure you check the **Allow write access** box, then click "Add key" and you're all set.
77+
Enter a name for your key and then paste the contents of your public key (`deploy_key.pub`) into the big textarea. Make sure you check the **Allow write access** box, then click "Add key" and you're all set.
7778

7879
### Configure the private key with Travis
7980

@@ -90,7 +91,7 @@ All that's left now is to set up Travis to run your deploys for you. The simples
9091
```yml
9192
after_success:
9293
- if [[ ($TRAVIS_BRANCH == master || -n $TRAVIS_TAG) && $EMBER_TRY_SCENARIO == ember-default ]]; then
93-
node_modules/.bin/ember deploy production;
94+
node_modules/.bin/ember deploy production;
9495
fi
9596
```
9697

0 commit comments

Comments
 (0)