weaveworks / weave-gitops-enterprise

This repo provides the enterprise level features for the weave-gitops product, including CAPI cluster creation and team workspaces.
https://docs.gitops.weave.works/
Apache License 2.0
160 stars 30 forks source link

Display template.description on the "Render template page" #2773

Closed foot closed 1 year ago

foot commented 1 year ago

https://github.com/weaveworks/weave-gitops-interlock/issues/397

Use case:

It would be helpful to display the description as that is the only way we can add explanation and notes to a template to display when being used.

Could be markdown, if there's a nice way to actually write markdown in the template? e.g.

apiVersion: templates.weave.works/v1alpha2
kind: GitOpsTemplate
metadata:
  name: vcluster-template-development
  namespace: default
  annotations:
    templates.weave.works/profiles-enabled: "true"
    templates.weave.works/add-common-bases: "true"
spec:
  description: |
    # A simple capv template
    ## instructions
  params:

Tasks

foot commented 1 year ago

https://gitlab.git.dev.weave.works/wge/pesto-demo-01/-/blob/main/clusters/management/templates/capv.yaml#L9

ahussein3 commented 1 year ago