salesforce / salesforce/cloudsplaining
Update documentation to reflect current features
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- JavaScript
- Stars
- 2.2k
- Forks
- 221
- Avg merge
- 3h 21m
- Merged PRs (30d)
- 8
Description
- 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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation Overview and the sections containing the triage worksheet, account-scanning description, risk list, and GIF. Update the feature descriptions for multiple AWS accounts, remove outdated worksheet references, replace the GIF, and add Credentials Exposure with links to the relevant ReadTheDocs definitions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, javascript
- Domain
- cloud, documentation, security
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100