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

Update setting-up-your-development-environment-to-create-a-github-app.md #25061

Merged
merged 4 commits into from
May 11, 2023

Conversation

edward
Copy link
Contributor

@edward edward commented Apr 17, 2023

Why:

Fixes up a link in https://docs.github.com/en/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app#step-5-review-the-github-app-template-code :

image

is now “Authenticating as a GitHub App”.

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

@welcome
Copy link

welcome bot commented Apr 17, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Apr 17, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Apr 17, 2023

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review github apps Content related to GitHub Apps and removed triage Do not begin working on this issue until triaged by the team labels Apr 21, 2023
@cmwilson21
Copy link
Contributor

@edward Thanks for submitting a PR! We appreciate the fix.

I do have a couple suggestions. I agree, the start of that paragraph should be "Authenticating as a GitHub App", but we try to avoid in-line links per our style guide. That's why the autotitle grabbed the article title instead. There are several in-line links in this article that will eventually get fixed, but for now, to help this specific section make better sense, would you mind:

  • removing the link from line 240 and leaving in Authenticating as a GitHub App.
  • adding the link to the end of line 245 per our style guide mentioned above. For more information, see "[AUTOLINK](path/to/page)

I think this will help the article flow better. Thanks again for pointing this out and opening a PR!

@cmwilson21 cmwilson21 self-requested a review April 21, 2023 19:07
@cmwilson21 cmwilson21 added the more-information-needed More information is needed to complete review label Apr 24, 2023
skedwards88
skedwards88 previously approved these changes Apr 24, 2023
Copy link
Contributor

@skedwards88 skedwards88 left a comment

Choose a reason for hiding this comment

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

Thanks for this fix! We'll get this merged down for you. Apologies: I missed @cmwilson21 's comment above.

Copy link
Contributor

@skedwards88 skedwards88 left a comment

Choose a reason for hiding this comment

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

edit: 🙈 I missed that @cmwilson21 had already reviewed this, but I agree with her ideas for improvement.

@skedwards88 skedwards88 self-requested a review April 24, 2023 17:50
Copy link
Contributor

@cmwilson21 cmwilson21 left a comment

Choose a reason for hiding this comment

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

LGTM 🚢

@cmwilson21 cmwilson21 enabled auto-merge May 11, 2023 20:23
@cmwilson21 cmwilson21 added ready to merge This pull request is ready to merge and removed more-information-needed More information is needed to complete review labels May 11, 2023
@cmwilson21 cmwilson21 added this pull request to the merge queue May 11, 2023
Merged via the queue into github:main with commit 227b44b May 11, 2023
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

gdamiaN538

This comment was marked as spam.

@edward edward deleted the patch-1 branch February 13, 2024 12:42
Papamuda1212 pushed a commit to Papamuda1212/docs that referenced this pull request Aug 17, 2024
….md (github#25061)

Co-authored-by: Courtney Wilson <77312589+cmwilson21@users.noreply.github.com>
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 github apps Content related to GitHub Apps ready to merge This pull request is ready to merge waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants