feat: add new golang script generatig examples doc on website #897
+510
−6
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a Go script that automatically generates website documentation
from example directories. The script reads examples.config.yaml to
determine which examples to process and generates Docusaurus-compatible
markdown files with frontmatter and tabbed manifest file displays.
The following is the sample docs generated by script:
This PR, as an MVP, targets the Go script and two examples (
examples/s3-bucketsandkubernetes/saas-multi-tenant) for automatic generation. The script is executed locally before creating the PR.Next steps:
go run go run scripts/generate-examples-doc.gotodeploy-docs.yaml)