Documentation update - Githubissues

cyberark / epv-api-scripts

These API scripts enable CyberArk users to automate privileged account management task like account creation, user management, and more.

https://www.cyberark.com/best

Apache License 2.0

195 stars 175 forks source link

Documentation update #387

Closed Aks-Tiaab closed 6 months ago

Aks-Tiaab commented 8 months ago

Desired Outcome

I wanted to make the documentation more readable and understandable by newbies (like me).

Implemented Changes

I went to every README.md files to:

correct some typos
re-arrange the titles/sub-titles order
make the descriptions less verbose, especially those for script's parameters.

Definition of Done

At least 1 todo must be completed in the sections below for the PR to be merged.

Changelog

[ ] The CHANGELOG has been updated, or
[X] This PR does not include user-facing changes and doesn't require a CHANGELOG update

Test coverage

[ ] This PR includes new unit and integration tests to go with the code changes, or
[X] The changes in this PR do not require tests

Documentation

[X] Docs (e.g. READMEs) were updated in this PR
[ ] A follow-up issue to update official docs has been filed here: [insert issue ID]
[ ] This PR does not require updating any documentation

Behavior

[ ] This PR changes product behavior and has been reviewed by a PO, or
[ ] These changes are part of a larger initiative that will be reviewed later, or
[X] No behavior was changed with this PR

Security

[ ] Security architect has reviewed the changes in this PR,
[ ] These changes are part of a larger initiative with a separate security review, or
[X] There are no security aspects to these changes