ansys / ansys/DevRelDocs

GH action to check docs validity during PR creation

Open
#228 7 comments 0 reactions 1 assignee Claimed by @rborsaru-ansys View on GitHub
enhancement
Dominant language
No language data
Stars
10
Forks
3
Avg merge
3d 23h
Merged PRs (30d)
13

Description

### 📝 Description of the feature

We want to be able to run some automated steps when a new set of documentation is added to DevRelDocs to help us during the PR approval process.
Some examples are:
- if the documentation is in zip format then open the zip and check the validity as per this documentation - https://doc-guidelines.dev.ansysapis.com/docs/migrate-dev-portal/migrate-package/doxygen-package/#preparation-of-the-output
- if the documentation is a OpenAPI example then we want to run a swagger test using this document and check if this is valid or now
- if the documentation is md format we want to run Vale linter against it and make sure it has a introduction/changelog pages.
This is a good start, but expect more to come.
A good example of a similar implementation could be found here:
https://github.com/ansys-internal/developer-documentation-guidelines

Thank you!

### 💡 Steps for implementing the feature

- create GH Action workflow that triggers from PR creation
- add zip val;idation job
- add OpenAPI check job
- add Vale validation job

### 🔗 Useful links and references

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.