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

Update documentation to reflect current features #178

Open
kmcquade opened this issue Apr 12, 2021 · 3 comments
Open

Update documentation to reflect current features #178

kmcquade opened this issue Apr 12, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@kmcquade
Copy link
Collaborator

  • There are still mentions of a triage worksheet. "Cloudsplaining identifies violations of least privilege in AWS IAM policies and generates a pretty HTML report with a triage worksheet. It can scan all the policies in your AWS account or it can scan a single policy file." The worksheet is mentioned several times.
  • As shown in the above, there is no mention of multiple AWS accounts
  • The GIF still shows the original Cloudsplaining version, not the version with VueJS that looks much better.
  • The list of risks in the second paragraph of the Overview does not include Credentials Exposure. These should also include links to the ReadTheDocs pages that include those definitions
@kmcquade kmcquade added the documentation Improvements or additions to documentation label Apr 12, 2021
@kmcquade
Copy link
Collaborator Author

Additionally, ReadTheDocs needs to be updated to include the above mentioned updates to the README

@kmcquade
Copy link
Collaborator Author

kmcquade commented Apr 12, 2021

Bullet points are incorrectly formatted in ReadTheDocs:
https://cloudsplaining.readthedocs.io/en/latest/user-guide/overview/

On that page, "worksheet" is mentioned too

Credentials exposure is not mentioned there either.

@kmcquade kmcquade added the good first issue Good for newcomers label Apr 28, 2021
@Jyotika999
Copy link

Hey @kmcquade can i work on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants