docs icon indicating copy to clipboard operation
docs copied to clipboard

Clarify OIDC process for AWS

Open baolsen opened this issue 3 years ago â€ĸ 6 comments

Why:

I've recently used the OIDC on AWS documentation and found it difficult to use. After some rummaging around the internet I managed to get a fully working example and expanded on the documentation in this PR accordingly.

Closes #19656 Relates to [#15324]

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • [x] 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).
  • [x] For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • [ ] This pull request impacts the contribution experience
    • [ ] I have added the 'writer impact' label
    • [ ] I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

baolsen avatar Aug 10 '22 13:08 baolsen

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.

welcome[bot] avatar Aug 10 '22 13:08 welcome[bot]

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** lib/search/indexes/** package*.json scripts/** translations/** content/actions/deployment/security-hardening-your-deployments/**

You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:

github-actions[bot] avatar Aug 10 '22 13:08 github-actions[bot]

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
actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md fpt
ghec
ghes@ 3.6 3.5
fpt
ghec
ghes@ 3.6 3.5

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

github-actions[bot] avatar Aug 10 '22 13:08 github-actions[bot]

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** lib/search/indexes/** package*.json scripts/** translations/** content/actions/deployment/security-hardening-your-deployments/**

You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:

github-actions[bot] avatar Aug 10 '22 13:08 github-actions[bot]

Preview of changes: https://docs-19657-beb2cd.preview.ghdocs.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services

baolsen avatar Aug 10 '22 14:08 baolsen

@baolsen Thanks for opening an issue and PR! I made a slight edit to your original message to connect the issue to this PR. ⚡

I'll get this triaged for the team to take a look 👀

cmwilson21 avatar Aug 10 '22 16:08 cmwilson21

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Aug 16 '22 06:08 github-actions[bot]

bump

baolsen avatar Aug 23 '22 10:08 baolsen

@baolsen Thanks for checking in on this. It's on the board and a team member will be reviewing it soon.

We appreciate your patience as we work through our backlog 💛

cmwilson21 avatar Aug 23 '22 13:08 cmwilson21

Branch was getting a bit stale, rebased.

baolsen avatar Sep 07 '22 06:09 baolsen

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** lib/search/indexes/** package*.json scripts/** translations/** content/actions/deployment/security-hardening-your-deployments/**

You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:

github-actions[bot] avatar Sep 07 '22 06:09 github-actions[bot]

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** lib/search/indexes/** package*.json scripts/** translations/** content/actions/deployment/security-hardening-your-deployments/**

You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:

github-actions[bot] avatar Sep 09 '22 04:09 github-actions[bot]

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** lib/search/indexes/** package*.json scripts/** translations/** content/actions/deployment/security-hardening-your-deployments/**

You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:

github-actions[bot] avatar Sep 09 '22 05:09 github-actions[bot]

Note about the "Check unallowed file changes" test: These changes have been approved by a member of the engineering team here: https://github.com/github/docs/pull/19657#pullrequestreview-1100423863

martin389 avatar Sep 09 '22 05:09 martin389

Changes look good in staging: https://docs-19657-beb2cd.preview.ghdocs.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services#configuring-the-role-and-trust-policy

martin389 avatar Sep 09 '22 05:09 martin389

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 :zap:

github-actions[bot] avatar Sep 09 '22 05:09 github-actions[bot]