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

Command highlighting and possible incorrect command in CONTRIBUTING.md #5081

Closed
TylerSanford opened this issue Apr 22, 2018 · 2 comments
Closed
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@TylerSanford
Copy link
Contributor

Description

Line 44 of CONTRIBUTING.md the command is not highlighting git clone which is a part of the command block.

Also the command git clone git@github.com:<your-username>/gatsby.git doesn't work for me.

Proposed new command line of git clone https://github.com/<your-username>/gatsby.git which does work for me every time.

Steps to reproduce

By viewing the doc CONTRIBUTING.md line 44, also by attempting the command as described: git clone git@github.com:<your-username>/gatsby.git

Expected result

Docs should have the whole command highlighted to eliminate confusion. Also command should properly clone the fork.

Actual result

`tsanford@Tylers-MacBook-Pro.local:~/Desktop$ git clone git@github.com:tylersanford/hello-world.git
Cloning into 'hello-world'...
git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.`

Environment

  • Gatsby version (npm list gatsby): N/A - Doc change
  • gatsby-cli version (gatsby --version): N/A - Doc change
  • Node.js version: node -v: v9.7.1
  • Operating System: macOS High Sierra 10.13.4

File contents (if changed):

CONTRIBUTION.md:
* Clone your fork: git clone https://github.com//gatsby.git``

TylerSanford referenced this issue in TylerSanford/gatsby Apr 22, 2018
@TylerSanford
Copy link
Contributor Author

First time contributing, #5082

@m-allanson
Copy link
Contributor

Fixed in #5082 🎉

@m-allanson m-allanson added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Apr 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

2 participants