docs icon indicating copy to clipboard operation
docs copied to clipboard

Broken markup in OIDC docs

Open porridge opened this issue 2 years ago • 3 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers#requesting-the-jwt-using-environment-variables

What part(s) of the article would you like to see updated?

The shell command should be:

        IDTOKEN=$(curl -H "Authorization: bearer ${{steps.script.outputs.TOKEN}}" ${{steps.script.outputs.IDTOKENURL}} -H "Accept: application/json; api-version=2.0" -H "Content-Type: application/json" -d "{}" | jq -r '.value')

But the stuff inside {{ }} seems to be pre-processed out, leaving just $ signs. See screenshot below.

Additional information

Screenshot from 2022-10-25 12-04-13


maintainer edit

Content plan here

porridge avatar Oct 25 '22 10:10 porridge

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

welcome[bot] avatar Oct 25 '22 10:10 welcome[bot]

@porridge Thanks so much for opening an issue! I'll triage this for the team to take a look :eyes:

cmwilson21 avatar Oct 25 '22 13:10 cmwilson21

Thanks for reporting this! All instances of ${{ ... }} need to be wrapped with {% raw %}/{% endraw %}` in order to render properly. You or anyone else is welcome to open a PR to address this.

skedwards88 avatar Oct 26 '22 22:10 skedwards88