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

remove workarounds for controller / router helm charts #1047

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jthurner
Copy link

As a result of a workaround with unescaped braces in the controller helm chart documentation, the docs currently render some garbled output:
image

This PR removes the workaround - depends on merging of openziti/helm-charts#298.

@jthurner jthurner requested review from a team as code owners February 12, 2025 10:28
Copy link

vercel bot commented Feb 12, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
ziti-doc ✅ Ready (Inspect) Visit Preview Feb 14, 2025 7:53am

Copy link
Member

@qrkourier qrkourier left a comment

Choose a reason for hiding this comment

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

The router chart's README failed to render as a Docusaurus page w/ error:

ReferenceError: release is not defined

@jthurner
Copy link
Author

Could you trigger the test deploy again? Should be fixed now.

This PR required the changes in openziti/helm-charts#298, but in that commit I only changed the documentation templates and did not run helm-docs to update the markdown files. That has happened now though with openziti/helm-charts#302 and openziti/helm-charts#301.

@jthurner jthurner requested a review from qrkourier February 13, 2025 08:11
Copy link
Member

@qrkourier qrkourier left a comment

Choose a reason for hiding this comment

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

Hmm. The Vercel build still says

Error: Can't render static file for pathname "/docs/guides/deployments/kubernetes/kubernetes-controller"

@jthurner
Copy link
Author

jthurner commented Feb 13, 2025

Weird. A fresh checkout of this branch builds without error locally.

I can only see yesterdays Vercel build, did it really run again?

@qrkourier
Copy link
Member

@jthurner I forgot to tell you this repo (and most ziti/rzok repos), require GitHub verified commits, which you can accomplish by signing with your GitHub-recognized PGP key.

I can sign your commits into an upstream branch or you can amend w/ gpg-sign and force push to your fork.

@jthurner
Copy link
Author

@qrkourier all set!

@qrkourier qrkourier requested a review from dovholuknf February 14, 2025 12:54
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