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 several issues in BUILDING.md, add missing config options #396

Merged
merged 3 commits into from
Jun 8, 2020

Conversation

ghost
Copy link

@ghost ghost commented Jun 5, 2020

Issue #, if available:

Description of changes:

  • Add deployer config options to correspond to the rest of the SAM template.
  • Move the deployer config docs from the example deployer script to BUILDING.md in the root.
  • Fully document the deployer config file, including the newly added options.
  • Link to the example deployer config scripts from the relevant step in BUILDING.md.
  • Document the test scripts.
  • Recast the deployment config parsing so it's easier to understand. (This helped me tremendously in creating this patch.)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

amazon-meaisiah added 2 commits June 4, 2020 16:18
Other changes:

- Moved all the deployer config docs from the example file to
  BUILDING.md for easier reading and formatting.
- Removed from the user-visible docs any trace of the `'request'` mode
  for account registration, as it's not currently supported and the
  existing implementation is untested and critically broken. It's just
  commented out, so anyone who views the source code can still see
  traces of it (and infer that it's a likely WIP feature).
- Revised the deployment scripts so I could better understand the
  numerous points of configuration. (It helped me write the rest of this
  patch.)
@ghost ghost force-pushed the clarify-deployer-config branch from 576c036 to 0a508cc Compare June 5, 2020 20:50
@MynockSpit MynockSpit merged commit 9175dd4 into staging Jun 8, 2020
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