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

Documentation for available policies #86

Merged
merged 9 commits into from
Jul 22, 2022
Merged

Conversation

rickygodoy
Copy link
Collaborator

  • Go script to crawl policies directory and generate markdown
  • GitHub Action to trigger the script when pushing to master

The script needs two parameters: policies folder and output file path, and it's possible to test the script locally (go run) and even test GH action locally using act

The idea here is to have a public markdown file with a list of policies to be referred from somewhere else and serve as documentation as well.

Not sure if it's the best approach, I'm open to suggestions :)

Copy link
Collaborator

@danielmarzini danielmarzini left a comment

Choose a reason for hiding this comment

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

I really like this, approving. Please, even in another PR if you want, a test would be awesome!

@rickygodoy
Copy link
Collaborator Author

rickygodoy commented Jul 15, 2022

Changed implementation to add generate-docs to CLI command and better integrate to existing source-code design.

Usage: ./gke-policy policy generate-docs -o your-file-name.md

Screen Shot 2022-07-15 at 13 29 23

Thanks!

@mikouaj mikouaj self-assigned this Jul 20, 2022
Copy link
Member

@mikouaj mikouaj left a comment

Choose a reason for hiding this comment

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

Great job!
My only doubt is about having documentation inside the policy package, I would rather have it in 'outputs' (even that it is not an evaluation results collector).

@rickygodoy
Copy link
Collaborator Author

rickygodoy commented Jul 21, 2022

Great job! My only doubt is about having documentation inside the policy package, I would rather have it in 'outputs' (even that it is not an evaluation results collector).

Changed to outputs package :)

@rickygodoy rickygodoy requested a review from mikouaj July 21, 2022 16:45
@rickygodoy
Copy link
Collaborator Author

Apologize for broken build, already fixed it.

Also changed CLI usage to ./gke-policy generate policy-docs -o your-file-name.md

Copy link
Member

@mikouaj mikouaj left a comment

Choose a reason for hiding this comment

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

LGTM!

@mikouaj mikouaj merged commit a4dcf2b into main Jul 22, 2022
@mikouaj mikouaj deleted the generate_policies_docs branch July 22, 2022 08:02
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.

3 participants