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

add github-actions documentation #1172

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

add github-actions documentation #1172

wants to merge 7 commits into from

Conversation

Killpit
Copy link

@Killpit Killpit commented Sep 17, 2024

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

Copy link
Member

@sigmavirus24 sigmavirus24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you also need to add this elsewhere for it to be included in a table of contents and be built and indexed properly

@Killpit
Copy link
Author

Killpit commented Sep 18, 2024

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

@Killpit
Copy link
Author

Killpit commented Dec 16, 2024

@sigmavirus24 I did the changes, can you check again

@sigmavirus24
Copy link
Member

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

@Killpit
Copy link
Author

Killpit commented Dec 22, 2024

@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

@ericwb
Copy link
Member

ericwb commented Feb 20, 2025

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

Copy link
Member

@ericwb ericwb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doc needs to be included as part of the index, otherwise it won't be part of the build output (except a direct link).

@Killpit
Copy link
Author

Killpit commented Feb 20, 2025

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

@sigmavirus24
Copy link
Member

That is not what Eric meant

@sigmavirus24
Copy link
Member

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

@Killpit
Copy link
Author

Killpit commented Feb 21, 2025

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

@Killpit
Copy link
Author

Killpit commented Feb 23, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants