-
Notifications
You must be signed in to change notification settings - Fork 363
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
Improve AWS Security Hub Documentation #7588
Comments
UpdateI've been reviewing the documentation section and I noted some items that we could improve. These are the suggestions:
Before implementing these items I'll put them in common with the documentation team to get feedback from them. |
UpdateAfter discussing the proposed items we decide to continue with:
|
Description
While working on Release 4.9.0 - Alpha 3 - E2E UX tests - Amazon Security Hub #24869, provided documentation for 4.9.0-alpha3 on configuring and setting AWS Security Hub presented a great deal of troubles, inhibiting from successfully implementing the configuration and thus allowing to pass the test successfully.
The document seems to be focused on experienced AWS users, where many concepts are assumed to be known, and many links to AWS documentation are provided, generating a lot of effort to accomplish a simple task that would be easier to configure if examples were provided.
It would be a lot easier for any user if the documentation provided examples and eventually references other documentation to learn more on the subject, but not to implement the feature itself.
Discarding regex option was not even possible to be tested since no event generation procedure was available (this might be a documentation or E2E design issue).
More details are provided in the Feedback section of the E2E issue, as well as in the comments.
The text was updated successfully, but these errors were encountered: