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

Add CRD reference docs #124

Merged
merged 1 commit into from Mar 18, 2024
Merged

Add CRD reference docs #124

merged 1 commit into from Mar 18, 2024

Conversation

ThorstenHans
Copy link
Contributor

As explained in #121 , this PR adds reference documentation for the SpinApp and SpinAppExecutor CRDs.

The PR contains

  • corresponding markdown files in content/en/docs/spin-operator/reference
  • individual configuration and template for crdoc (see https://github.com/fybrik/crdoc)
  • a generate shell script that is executed as part of the GitHub Action to ensure reference is matching CRDs provided as part of the spin-operator release
  • a new npm task called generate:crd:reference that could be used locally, to generate references.

The GitHub Action has been updated as well to generated reference for a configurable release of Spin Operator during CI

This commit adds reference docs for CRDs provided by Spin Operator. Reference documentation is generated based on CRDs published as part of the spin-operator release.

Signed-off-by: Thorsten Hans <thorsten.hans@fermyon.com>
Copy link
Contributor

@vdice vdice left a comment

Choose a reason for hiding this comment

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

Very slick!

@ThorstenHans ThorstenHans merged commit ff45447 into main Mar 18, 2024
@ThorstenHans ThorstenHans deleted the feature/crd-reference branch March 18, 2024 18:48
@ThorstenHans ThorstenHans restored the feature/crd-reference branch March 18, 2024 18:50
@ThorstenHans ThorstenHans deleted the feature/crd-reference branch March 18, 2024 18:53
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.

None yet

2 participants