Initial FAQ, with hopefully more contributions in the future. #1202
Conversation
|
Default IntelliJ Markdown auto-formatting is, subjectively, counter-productive and, objectively, unnecessarily verbose. Fortunately, there's a way to disable some unhelpful IntelliJ edits: https://blog.jetbrains.com/webstorm/2023/01/webstorm-2023-1-eap-1/#new_smart_keys_settings_page_for_markdown (i.e., disable "Reformat table") |
There was a problem hiding this comment.
Overall I think it is a great idea. I want to make sure that if we are adding to this document that it is visible enough for people to find, and that there isn't a better place for an FAQ (like an amazon owned webpage) but personally I think keeping it close to the code is the best
| @@ -0,0 +1,29 @@ | |||
| # Frequently Asked Questions (FAQ) | |||
There was a problem hiding this comment.
This is a great idea. Can we add this FAQ as a link to the README for increased visibility?
There was a problem hiding this comment.
SGTM. Will follow-up w/ a separate PR soas not to unnecessarily delay merging this incremental value.
This FAQ, and any future documentation, is not required to be an either/or. We can, and as reasonable, should do both. However, there are much higher hurdles to author, publish, and edit (when necessary) public AWS docs. Furthermore, external contributors such as KCL Cx cannot contribute to AWS documentation. This PR biases us towards action, helps set a precedent, and (hopefully) will snowball into more extensive results. |
Issue #, if available:
N/A
Description of changes:
Initial FAQ, with hopefully more contributions in the future.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.