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.

Sign up for GitHub

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

Jump to bottom

Allow for markdown in workflow title/description in UI #10126

Closed
jmeridth opened this issue Nov 28, 2022 · 1 comment · Fixed by #10553
Closed

Allow for markdown in workflow title/description in UI #10126

jmeridth opened this issue Nov 28, 2022 · 1 comment · Fixed by #10553
Assignees
@jmeridth
Labels
area/spec Changes to the workflow specification. area/ui type/feature Feature request
Milestone
v3.6.0

Comments

@jmeridth
Copy link
Member

jmeridth commented Nov 28, 2022 •
edited
Loading

Summary

Allow for markdown in title or description on workflows list in UI. #6529 introduced the title and description text via annotations. This is a quick follow and will allow markdown.

spec:
  annotations:
    workflows.argoproj.io/title: '**Build and test**'
    workflows.argoproj.io/description: '`SuperDuperProject` PR #6529: Implement frobbing (aff39ee)'

Results in:

Build and test
SuperDuperProject PR #6529: Implement frobbing (aff39ee)

Motivation

This will allow markup and linking to occur on the UI title and/or description

Use Cases

Example: linking back to the GitHub PR that issued the workflow in a CI example

Note

@jmeridth (author of #9805 - title/description PR) experienced javascript errors when trying to introduce markdown (via react-markdown library). Example error here

Based on this open issue in swagger-ui repo that shows the same error, there might be a conflict with react-markdown and swagger-ui. Upgrading webpack did not work previously.

Kudos

Kudos to @atombender for the original issue and idea for this feature

Message from the maintainers:

Love this enhancement proposal? Give it a 👍. We prioritise the proposals with the most 👍.
@jmeridth jmeridth added the type/feature Feature request label Nov 28, 2022
@jmeridth
Copy link
Member Author

I'm going to work on this one @terrytangyuan as a quick follow to #6529. Thanks. If I get bogged down or can't, I'll ask to release to others.

jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 17, 2023
@jmeridth @bencompton @jordanblum1
feat(markdown): Allow markdown in workflow title and description
1ba46bf 
Fixes: argoproj#10126

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
Co-authored-by: jordanblum1 <jordanblum19@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 20, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
2a6dbbe 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
@jmeridth jmeridth mentioned this issue Feb 20, 2023
Merged
20 tasks
@jmeridth jmeridth self-assigned this Feb 20, 2023
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 21, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
5cedf49 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 23, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
6206a6a 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 24, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
fc999fb 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 24, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
9e5f065 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 24, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
93c43f9 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 26, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
498ce6f 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 26, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
adafc2d 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 28, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
b95bc24 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Feb 28, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
b39161e 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Mar 1, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
3636854 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Mar 1, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
2e85240 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Mar 5, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
0418ef9 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Mar 5, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
81d5192 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Mar 5, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
e0075a8 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Mar 19, 2023
@jmeridth @bencompton
feat(markdown): Allow markdown in workflow title and description
02af38b 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: bencompton <benjamincompton@gmail.com>
Signed-off-by: jmeridth <jmeridth@gmail.com>
@jmeridth jmeridth mentioned this issue Jul 21, 2023
Merged
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Sep 20, 2023
@jmeridth
feat(markdown): Allow markdown in workflow title and description
e0ebac3 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page

Signed-off-by: jmeridth <jmeridth@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Dec 26, 2023
@jmeridth
feat(markdown): Allow markdown in workflow title and description
f423a28 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page
- [x] make first column of workflow row not be wrapped in row link so markdown links can be clicked
- [x] change remark-gfm to 3.0.0 based on remarkjs/react-markdown#771 (comment)

Signed-off-by: jmeridth <jmeridth@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Dec 27, 2023
@jmeridth @stevenbjohnson
feat(markdown): Allow markdown in workflow title and description
15f7251 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page
- [x] make first column of workflow row not be wrapped in row link so markdown links can be clicked
  - [x] add overlay so users can still click to open workflow
- [x] change remark-gfm to 3.0.0 based on remarkjs/react-markdown#771 (comment)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Steven Johnson <52087249+stevenbjohnson@users.noreply.github.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Dec 29, 2023
@jmeridth @stevenbjohnson
feat(markdown): Allow markdown in workflow title and description
17e3e70 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page
- [x] make first column of workflow row not be wrapped in row link so markdown links can be clicked
  - [x] add overlay so users can still click to open workflow
- [x] change remark-gfm to 3.0.0 based on remarkjs/react-markdown#771 (comment)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Steven Johnson <52087249+stevenbjohnson@users.noreply.github.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Dec 29, 2023
@jmeridth @stevenbjohnson
feat(markdown): Allow markdown in workflow title and description
a9efa36 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page
- [x] make first column of workflow row not be wrapped in row link so markdown links can be clicked
  - [x] add overlay so users can still click to open workflow
- [x] change remark-gfm to 3.0.0 based on remarkjs/react-markdown#771 (comment)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Steven Johnson <52087249+stevenbjohnson@users.noreply.github.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Dec 29, 2023
@jmeridth @stevenbjohnson
feat(markdown): Allow markdown in workflow title and description
416139f 
Fixes: argoproj#10126

- [x] new react component for handling workflow row name
- [x] new css file to manage row name column
- [x] new example file for title and description with markdown
- [x] include `remark-gfm` for GitHub Friendly Markdown (aka urls automatically translate to links)
- [x] Add User Guid -> UI Features -> Title and Description docs page
- [x] make first column of workflow row not be wrapped in row link so markdown links can be clicked
  - [x] add overlay so users can still click to open workflow
- [x] change remark-gfm to 3.0.0 based on remarkjs/react-markdown#771 (comment)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Steven Johnson <52087249+stevenbjohnson@users.noreply.github.com>
terrytangyuan pushed a commit that referenced this issue Dec 30, 2023
@jmeridth @stevenbjohnson
feat: Allow markdown in workflow title and description. Fixes #10126 (#…
0a8ca81 
…10553)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Steven Johnson <52087249+stevenbjohnson@users.noreply.github.com>
@agilgur5 agilgur5 added area/ui area/spec Changes to the workflow specification. labels Dec 30, 2023
hittingray pushed a commit to atlassian-forks/argo-workflows that referenced this issue Jan 3, 2024
@jmeridth @stevenbjohnson @hittingray
feat: Allow markdown in workflow title and description. Fixes argopro…
99512db 
…j#10126 (argoproj#10553)

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Steven Johnson <52087249+stevenbjohnson@users.noreply.github.com>
@agilgur5 agilgur5 added this to the v3.6.0 milestone Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jmeridth jmeridth

Labels
area/spec Changes to the workflow specification. area/ui type/feature Feature request
Projects
Argo Workflows UI/UX Improvements
Status: Done
Milestone
v3.6.0
Development

Successfully merging a pull request may close this issue.

feat: Allow markdown in workflow title and description. Fixes #10126 jmeridth/argo-workflows
2 participants
@jmeridth @agilgur5