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

GitHub App Guide typo #129

Closed
6 tasks
rsese opened this issue May 25, 2020 · 4 comments
Closed
6 tasks

GitHub App Guide typo #129

rsese opened this issue May 25, 2020 · 4 comments
Labels
content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team

Comments

@rsese
Copy link
Member

rsese commented May 25, 2020

Issue overview

Hiyo 👋! User reporting a typo in https://developer.github.com/apps/quickstart-guides/setting-up-your-development-environment/#step-4-prepare-the-runtime-environment:

I noticed a typo in the Developer Docs: https://developer.github.com/apps/quickstart-guides/setting-up-your-development-environment/

In Step 4, in the example .env file at the end, PRIVATE_KEY should be GITHUB_PRIVATE_KEY

So this is the example .env file at the end of step 4.

I think they're right? The template code to start from that we mention in the Prerequisites section uses GITHUB_PRIVATE_KEY:

https://github.com/github-developer/github-app-template/blob/d73485c3ef88d351fbd45b11666c045b319f7f49/.env-example#L1

Products affected by this issue

  • REST API
  • GraphQL API
  • Apps
  • GitHub Actions
  • GitHub Marketplace
  • Webhooks

/cc @github/product-docs-ecosystem

@rachmari
Copy link
Contributor

rachmari commented May 27, 2020

@rsese yes, I think you're correct. It looks like there are other instances where we use PRIVATE_KEY instead of GITHUB_PRIVATE_KEY that we might want to fix in the article too.

@rachmari rachmari transferred this issue from another repository Sep 25, 2020
@janiceilene janiceilene transferred this issue from another repository Oct 6, 2020
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 6, 2020
@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team and removed triage Do not begin working on this issue until triaged by the team labels Oct 6, 2020
@casals
Copy link
Contributor

casals commented Oct 7, 2020

It's not possible to edit this page (hosted at https://developer.github.com) at the moment since it was deprecated in favor of https://docs.github.com/apps/quickstart-guides/setting-up-your-development-environment/ . The new page has the right text (GITHUB_PRIVATE_KEY on Step 4). I suggest either closing this issue or referencing it to the internal team.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 7, 2020
@janiceilene janiceilene removed the triage Do not begin working on this issue until triaged by the team label Oct 7, 2020
@janiceilene
Copy link
Contributor

Thanks for looking into that @rsese! @github/docs-content-ecosystem Can we close this issue?

@jmarlena
Copy link
Contributor

jmarlena commented Oct 8, 2020

Yes, we can close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team
Projects
None yet
Development

No branches or pull requests

5 participants