Add FAQ section to docs #314
Conversation
|
This is awesome!!!! I will take a look later today. |
| @@ -1,5 +1,5 @@ | |||
| CloudFormation Compatibility Section | |||
| =============== | |||
| ==================================== | |||
There was a problem hiding this comment.
Thank you! What did you use to catch these?
There was a problem hiding this comment.
Just the warnings from sphinx-build when running make html :)
There was a problem hiding this comment.
Nice. Will keep that in mind in the future :)
docs/faq.rst
Outdated
| How to manage multiple environments? | ||
| ------------------------------------ | ||
|
|
||
| *Terminology clarification: Environment and Stage can normally be used interchangeably but since AWS Gateway relies on a concrete concept of Stages we'll use the term Environment here to avoid confusion.* |
docs/faq.rst
Outdated
| How to enable API Gateway Logs | ||
| ------------------------------ | ||
|
|
||
| Work is underway to make this functionality part of the SAM specification. Until then the suggested workaround is to use the ``aws cli update-stage`` command to enable this manually after a Clouformation deployment. |
There was a problem hiding this comment.
Can you add a note about the following:
If you are to follow this, you will see metric gaps between the time CloudFormation deployed and the time you run this command.
Might be worth suggesting another option would be to create a custom resource that does this as well. I do know of customers going this route.
|
Thank you for doing this. Great addition :) Sorry it took me some time. I was out of the office for part of last week. |
2 participants
As suggested by @jfuss here is an initial stab at an FAQ section for the docs.
Currently contains only a couple of questions - how to deal with multiple environments/stages, and how to enable logs in gateway.
Let me know if this useful in its present form or whether the official recommendations are different from what I thought.