Skip to content

fix: correct contributor-facing README docs#2823

Open
immanuwell wants to merge 1 commit into
pulumi:masterfrom
immanuwell:fix/readme-template-docs
Open

fix: correct contributor-facing README docs#2823
immanuwell wants to merge 1 commit into
pulumi:masterfrom
immanuwell:fix/readme-template-docs

Conversation

@immanuwell

Copy link
Copy Markdown

Summary

Fix a small docs papercut in contributor facing READMEs.
The README template had busted comment markup plus a typo, and testing-integration/README.md opened with a broken sentence. Pretty small fix, but it cleans up stuff people actually read and copy.

Repro:

  • git show origin/master:example-readme-template.md.txt | sed -n '10,20p'
  • git show origin/master:testing-integration/README.md | sed -n '1,5p'

Example(s) affected

  • example-readme-template.md.txt
  • testing-integration

Validation

git diff --check

(no output)

rg -n "exampleas|infrastucture|If deploys" example-readme-template.md.txt testing-integration/README.md

(no output)

Checklist

  • No hardcoded credentials or secrets
  • No Pulumi.*.yaml stack config files included

@github-actions

Copy link
Copy Markdown

PR is now waiting for a maintainer to run the acceptance tests.
Note for the maintainer: To run the acceptance tests, please comment /run-example-tests on the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant