Skip to content

Use Markdown for health check suggestions #30

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

Open
srid opened this issue Aug 15, 2023 · 4 comments
Open

Use Markdown for health check suggestions #30

srid opened this issue Aug 15, 2023 · 4 comments
Labels
good first issue Good for newcomers

Comments

@srid
Copy link
Member

srid commented Aug 15, 2023

For "suggestions" we currently use String,

https://github.com/juspay/nix-browser/blob/24d41410b017be10d1fe94c641301ef1a348d1ed/src/nix/health/report.rs#L22-L29

We should change this to use a Markdown type, and correspondingly render the Markdown on the frontend.

There is https://github.com/rambip/leptos-markdown we can use for this.

@srid srid added the good first issue Good for newcomers label Aug 20, 2023
@srid srid changed the title Use Markdown for health check diagnostics Use Markdown for health check suggestions Aug 27, 2023
@1vipulgupta 1vipulgupta self-assigned this Aug 27, 2023
@srid
Copy link
Member Author

srid commented Aug 31, 2023

@1vipulgupta Just a heads up: with juspay/omnix#53 merged you want to base your work on top of the new master, since there has been an re-organization (see crates/nix_health in particular).

@srid

This comment was marked as outdated.

srid referenced this issue in juspay/omnix Sep 14, 2023
Now, the check types represent the check configuration - rather than the check result. Consequently, we are also able to get rid of all the per-check leptos views (in future, check.info would use Markdown via #34).
@srid
Copy link
Member Author

srid commented Oct 12, 2023

With the move to Dioxus, we should probably use https://github.com/DioxusLabs/markdown

@1vipulgupta 1vipulgupta linked a pull request Nov 3, 2023 that will close this issue
@srid srid transferred this issue from juspay/omnix Jul 15, 2024
@srid
Copy link
Member Author

srid commented Jul 15, 2024

(Moved it to nix-health repo; can we render Markdown in terminal?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants