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

feat: Config reference documentation autogeneration #2033

Open
wants to merge 35 commits into
base: main
Choose a base branch
from

Conversation

ilyakuz-db
Copy link
Contributor

@ilyakuz-db ilyakuz-db commented Dec 18, 2024

Changes

Documentation autogeneration tool. This tool uses same annotations_*.yml files as in json-schema

Result will go there and there

Tests

Manually

@eng-dev-ecosystem-bot
Copy link
Collaborator

Test Details: go/deco-tests/12401106836

Copy link

github-actions bot commented Jan 3, 2025

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/cli

Inputs:

  • PR number: 2033
  • Commit SHA: c6703c13637c0d85e6754e4c802f38052304a5d6

Checks will be approved automatically on success.

@ilyakuz-db ilyakuz-db changed the title [WIP] feat: Config reference documentation autogeneration feat: Config reference documentation autogeneration Jan 13, 2025
md "github.com/nao1215/markdown"
)

const (
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These templates are in this repo temporary to simplify the process of docs updating

This can be further improved by using include declarations in doc repo so we could generate only meaningful part here and store the wrapper file in docs repo

type annotationHandler struct {
// Annotations read from all annotation files including all overrides
parsedAnnotations annotationFile
parsedAnnotations annotation.File
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved annotations to separate package but yaml files kept as is to avoid messy conflicts. Will move them right before merging

@ilyakuz-db ilyakuz-db deployed to test-trigger-is January 14, 2025 12:00 — with GitHub Actions Active
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.

2 participants