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

Fix example in README.md #131

Merged
merged 6 commits into from
Mar 26, 2021
Merged

Fix example in README.md #131

merged 6 commits into from
Mar 26, 2021

Conversation

Appelberg-s
Copy link
Contributor

what

  • The example provided in the README.md gave an error when trying to run it since it set the attribute environment when it was probably trying set the attribute container_environment.

The example provided in the README.md gave an error when trying to run it since it set the attribute `environment` when it was probably trying set the attribute `container_environment`.
@Appelberg-s Appelberg-s requested review from a team as code owners March 8, 2021 21:43
@Appelberg-s Appelberg-s requested review from 3h4x and nitrocode March 8, 2021 21:43
@Nuru
Copy link
Contributor

Nuru commented Mar 18, 2021

@Appelberg-s Thank you for your contribution.

In Cloud Posse's repos, README.md is usually a generated file. You need to make your change in README.yaml which is the main source for generating README.md.

After making changes to README.yaml (and assuming you have Docker installed) you can run:

  • make init
  • make pr/auto-format

to generate the README.md and other documentation. Then check in and push the changed files and you should be good to go.

Nuru
Nuru previously requested changes Mar 18, 2021
Copy link
Contributor

@Nuru Nuru left a comment

Choose a reason for hiding this comment

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

Make changes to README.yaml not README.md

@mergify mergify bot dismissed Nuru’s stale review March 18, 2021 19:38

This Pull Request has been updated, so we're dismissing all reviews.

@Appelberg-s
Copy link
Contributor Author

Thanks for the feedback! Made the suggested changes in the latest commit.

nitrocode
nitrocode previously approved these changes Mar 19, 2021
@nitrocode
Copy link
Member

/test all

@nitrocode nitrocode requested a review from Nuru March 26, 2021 20:15
@jamengual
Copy link
Contributor

Thanks for the feedback! Made the suggested changes in the latest commit.

you need to revert back the README.md and only leave your changes in the README.yaml and run :

make init
make github/init
make readme

@nitrocode
Copy link
Member

/rebuild-readme

@mergify
Copy link

mergify bot commented Mar 26, 2021

This pull request is now in conflict. Could you fix it @Appelberg-s? 🙏

@nitrocode
Copy link
Member

/test all

@nitrocode nitrocode merged commit f6e5ae9 into cloudposse:master Mar 26, 2021
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.

6 participants