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.

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

Add a link to CircleCI documentation on keys #19

Closed
wants to merge 4 commits into from

Conversation

arokem
Copy link
Contributor

@arokem arokem commented Apr 29, 2016

No description provided.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 37b6678 on arokem:patch-1 into 5b72257 on scikit-learn-contrib:master.

@arokem
Copy link
Contributor Author

arokem commented Apr 29, 2016

Might need even more documentation, considering that CircleCi does not take encrypted keys. Still working on that :-)

@arokem
Copy link
Contributor Author

arokem commented Apr 29, 2016

OK. This might be enough.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling b90197f on arokem:patch-1 into 5b72257 on scikit-learn-contrib:master.

@@ -149,18 +149,21 @@ In addition to this, you will need to grant access to the CircleCI computers
to push to your documentation repository. To do this, visit the Project Settings
page of your project in CircleCI. Select `Checkout SSH keys` option and then
choose `Create and add user key` option. This should grant CircleCI privileges
to push to the repository `https://github.com/USERNAME/DOC_REPO/`.
to push to the repository `https://github.com/USERNAME/DOC_REPO/`
(see: https://circleci.com/docs/adding-read-write-deployment-key/; make sure
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatting could be a little better. Also to be consistent with the rest of the documentation, it would be better if we had a named link here, for eg:
[Circle CI documentation on ssh keys](...url...)

@arokem
Copy link
Contributor Author

arokem commented May 12, 2016

Thanks for the feedback. How's this?

@vighneshbirodkar
Copy link
Member

@arokem Thanks for your contribution.My only concern here is that from the method currently suggested ( going to Project settings and clicking on "Create and add user key"), there is no way to add add a password protected key.

I think a better way to put it would be :

Follow these instructions if you want to [manually add an SSH key](...url...) and make sure they key isn't password protected.

My point is that a novice user should not be confused by these instructions if the CircleCI web gui can do it for him/her.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 9790a3f on arokem:patch-1 into 5b72257 on scikit-learn-contrib:master.

@arokem
Copy link
Contributor Author

arokem commented May 12, 2016

On Thu, May 12, 2016 at 11:05 AM, Vighnesh Birodkar <
notifications@github.com> wrote:

@arokem https://github.com/arokem Thanks for your contribution.My only
concern here is that from the method currently suggested ( going to Project
settings and clicking on "Create and add user key"), there is no way to add
add a password protected key.

Do you mean "from the method currently suggested ( going to Project
settings and clicking on "Create and add user key"), there is no way to add
a key that is not password protected"? That's the thing that led me to
this PR. CircleCI couldn't commit to the gh-pages branch, because the thing
that happens per default is that a password-protected key is generated.
You need to follow the instructions on that CircleCI documentation page,
but particularly, when you follow the link through to this page:
https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/,
you would need to skip through step 4 without generating a password
(simply pressing [Enter] twice would do it), for it to actually work.

The question is: how do we best communicate that?

I think a better way to put it would be :

Follow these instructions if you want to manually add an SSH key and make sure they key isn't password protected.

My point is that a novice user should not be confused by these
instructions if the CircleCI web gui can do it for him/her.


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#19 (comment)

@vighneshbirodkar
Copy link
Member

@arokem The currently suggested method adds keys which are not password protected. Moreover, it never asks for the password. I say that because that's what I did and it worked.

How did you create SSH keys ?

@arokem
Copy link
Contributor Author

arokem commented May 18, 2016

TBH, I don't remember. I think that I tried to follow the instructions
here, and that it led to me having a password protected key, but maybe I am
wrong and this patch isn't necessary? You can close it for now.

On Thu, May 12, 2016 at 11:44 AM, Vighnesh Birodkar <
notifications@github.com> wrote:

@arokem https://github.com/arokem The currently suggested method adds
keys which are not password protected. Moreover, it never asks for the
password. I say that because that's what I did and it worked.

How did you create SSH keys ?


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#19 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants