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: Allow markdown title and description in KeyValueEditor #13935

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

Conversation

panicboat
Copy link
Contributor

@panicboat panicboat commented Nov 25, 2024

Fixes #13934

Motivation

Our organization allows non-developers to submit workflows using Argo Workflows.
However, since non-developers only submit WorkflowTemplate, etc., we need to have them read the Workflow description from the UI.
For this reason, we adopted markdown, which is easier to read.

Modifications

If the KeyValueEditor key is workflows.argoproj.io/title or workflows.argoproj.io/description, it is now expressed in markdown.

ClusterWorkflowTemplate

image

CronWorkflow

image

WorkflowTemplate

image

Verification

On the Metadata tab below, we have verified that the Title and Description are marked down.
Also verified that all other fields have not changed.

  • CronWorkflow
  • ClusterWorkflowTemplate
  • WorkflowTemplate
  labels:
    workflows.argoproj.io/title: Test-Title
    workflows.argoproj.io/description: This-is-a-simple-hello-world-example
  annotations:
    workflows.argoproj.io/title: '**Test Title**'
    workflows.argoproj.io/description: |
      `This is a simple hello world example.`
      You can also run it in Python: https://couler-proj.github.io/couler/examples/#hello-world

I have verified that no other changes have been made to the Input windows of ClusterWorkflowTemplate and WorkflowTemplate.

@panicboat panicboat force-pushed the allow-markdown-in-key-value-editor branch 2 times, most recently from a2b61fc to 095d686 Compare November 25, 2024 06:47
@panicboat panicboat force-pushed the allow-markdown-in-key-value-editor branch from 095d686 to c8e9fcf Compare November 25, 2024 06:51
@panicboat panicboat marked this pull request as ready for review November 25, 2024 07:05
@blkperl blkperl added the area/ui label Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow markdown title and description in KeyValueEditor
3 participants