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

Validate documentation formating and templating #1075

Open
Fran-Rg opened this issue Feb 5, 2025 · 0 comments
Open

Validate documentation formating and templating #1075

Fran-Rg opened this issue Feb 5, 2025 · 0 comments

Comments

@Fran-Rg
Copy link

Fran-Rg commented Feb 5, 2025

I was trying to review and transform the documentation into a more queryable format. While doing this I was parsing the .md documentation files but found lots of inconsistency in the formating of the policy details documentations.

To give an example, if I base that this is the default standard:
https://raw.githubusercontent.com/hlxsites/prisma-cloud-docs/refs/heads/main/docs/en/enterprise-edition/policy-reference/aws-policies/aws-iam-policies/bc-aws-2-40.adoc

Comparing with: https://raw.githubusercontent.com/hlxsites/prisma-cloud-docs/refs/heads/main/docs/en/enterprise-edition/policy-reference/aws-policies/aws-logging-policies/bc-aws-logging-12.adoc

There are quite a few differences:

  • extra space at the end: |=== -> |===
  • extra new line
== TITLE

=== Policy Details

->

== TITLE


=== Policy Details
  • extra return line
|Subtype
|Run,Build

->

|Subtype
|Build
//, Run

And these are some minor differences, I've found documents with wildly different format.

Actions

  • Add a format check for the document on PRs
  • Provide a tool to general a template for new rules
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

No branches or pull requests

1 participant