hlxsites / hlxsites/prisma-cloud-docs
Validate documentation formating and templating
- Dominant language
- JavaScript
- Stars
- 21
- Forks
- 92
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
Assessment
This issue has not been assessed yet.