loft-sh / vcluster-docs

Apache License 2.0
4 stars 21 forks source link

Workflow to build CLI docs update PR when a vCluster relase is created. #230

Closed zerbitx closed 1 month ago

zerbitx commented 1 month ago

πŸ’‘ The intent

In vcluster Repo

In vcluster-docs (When triggered)

Example workflow creating the PR Example Generated PR *Note I used dummy values like "No title" vCluster PR

netlify[bot] commented 1 month ago

Deploy Preview for vcluster-docs-site ready!

Name Link
Latest commit 0b98a1d8a31ecff606c56b73210c93290efa20c2
Latest deploy log https://app.netlify.com/sites/vcluster-docs-site/deploys/66ba2c3c42d65e0008ecfdce
Deploy Preview https://deploy-preview-230--vcluster-docs-site.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

zerbitx commented 1 month ago

The catgory json file is docusaurus metadata. With that in place, but no markdown files, nothing shows up in the docs so it looks like

Screenshot 2024-08-12 at 11 08 18

Once the generated docs are copied into that directory along side the json file we get results like

Screenshot 2024-08-12 at 11 10 12

πŸ‘†collapsed

Screenshot 2024-08-12 at 11 10 17

πŸ‘† expanded