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 minor corrections in setup guide #754

Merged
merged 3 commits into from
Dec 18, 2024

Conversation

arpitpatawat
Copy link
Member

@arpitpatawat arpitpatawat commented Dec 17, 2024

Issue #, if available:
Nil
Description of changes:

  1. Added Amazon Root CA certificate which also needs to be configured, in the Setup readme.
  2. Reordered the sequence of parameters which needs to be configured, based on docs/examples/sample_nucleus_config.yaml
  3. Renamed docs/examples/sample_nucleus_config.yml -> docs/examples/sample_nucleus_config.yaml since later, .yaml is being used, and it might create a confusion for yml and yaml, although they are the same - (https://stackoverflow.com/questions/22268952/what-is-the-difference-between-yaml-and-yml-extension)
  4. Added instructions to copy the sample configuration as config.yaml rather than init_config.yml, since later it is being copied as config.yaml.
  5. Changed the example config path display from doc/... to docs/....

PS: Please let me know if there was any plan for having .yml extension for the sample configuration, just so that this PR does not break anything (although it does not make much sense since later it was changed to .yaml). Additionally, I have not run and tested the service completely, just updated these minor changes. Please have this in mind while reviewing. Thank you.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@arpitpatawat arpitpatawat changed the title Setup guide minor fixes Fix minor corrections in setup guide Dec 18, 2024
@rawalexe rawalexe merged commit 0d0e4cd into aws-greengrass:main Dec 18, 2024
15 checks passed
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.

2 participants