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

extended system description on affected-page (with markdown support) #270

Open
MirMiz opened this issue Apr 20, 2023 · 1 comment
Open

Comments

@MirMiz
Copy link
Contributor

MirMiz commented Apr 20, 2023

Is your feature request related to a problem? Please describe.
The systems are defined as array in config.yml. the description-Attribute allows for some plaintext - markdown won't be evaluated, however.
Use Case: Displaying the systems status is nice. You can privide additional benefit for the user, by referencing the Link to the documentation and/or a link to issue a ticket for this system. and maybe some lines of system description.
cstate currently allows for only one additional link and a short plaintext description

Describe the solution you'd like
it would be helpful, if the description on the "affected"-pages would allow for markdown. (and thus links)
You could seperate the "description" field in config.yml into tooltip (plaintext) and description (markdown).

Describe alternatives you've considered
I used cstate additional link in config.yml to point to an additinal page I created for each system.
this way, however, I have two pages per system:

  1. the cstate-incident-page for the system (by clicking on the systems name)
  2. my additional docu-and-tickettool-link-page (by clicking on the link-icon)
    That's not that neat and userfriendly as having only one page :/

Additional context
Some Mockup: (HTML oder Markdown not evaluatet, however)
grafik

@MirMiz
Copy link
Contributor Author

MirMiz commented Apr 21, 2023

alternatifly to | safeHTML you could use | markdownify if you want to stick in Markdown rather then HTML for user content

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants