bandit icon indicating copy to clipboard operation
bandit copied to clipboard

add github-actions documentation

Open Killpit opened this issue 1 year ago • 1 comments

There was an issue about documentations in GitHub Actions and had to look for the GitHub repo, added GitHub Actions documentation in ci-cd part to make sure it can easily be learned and utilised for CI/CD without further research for users

Killpit avatar Sep 17 '24 13:09 Killpit

@sigmavirus24, I did the recommended changes, can you check it again?

Killpit avatar Sep 18 '24 12:09 Killpit

@sigmavirus24 I did the changes, can you check again

Killpit avatar Dec 16 '24 11:12 Killpit

I left specific comments but please look at the other rst files to understand the proper way to write RST and follow the same general style

sigmavirus24 avatar Dec 16 '24 11:12 sigmavirus24

@sigmavirus24 can you check the changes again, I looked at your suggestions and other .rst files to format the changes and also formatted the list table to further be compliant with the .rst rules. Even had a last commit

Killpit avatar Dec 22 '24 16:12 Killpit

Output of the docs build: https://bandit--1172.org.readthedocs.build/en/1172/

ericwb avatar Feb 20 '25 19:02 ericwb

I added index.rst similar to other directories, can you review it again? @sigmavirus24 @ericwb

Killpit avatar Feb 20 '25 21:02 Killpit

That is not what Eric meant

sigmavirus24 avatar Feb 20 '25 22:02 sigmavirus24

The file needs to be referenced in a toctree from an existing document. Now that index you generated is also a leaf

sigmavirus24 avatar Feb 20 '25 22:02 sigmavirus24

@sigmavirus24 @ericwb I think I did what you guys asked, can you check again

Killpit avatar Feb 21 '25 08:02 Killpit

@ericwb @sigmavirus24 completed all the suggestions, can you guys check again

Killpit avatar Feb 23 '25 08:02 Killpit