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

launching-workflows: mention launcher badge generator #187

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

Conversation

giuseppe-steduto
Copy link
Member

@@ -135,22 +135,13 @@ The standard set of badges look as follows:

![Launch with Snakemake REANA at CERN](https://www.reana.io/static/img/badges/launch-with-snakemake-on-reana-at-cern.svg)

If you would like to generate your own custom badge, you can use external services such as [shields.io](https://shields.io) or [badgen.net](https://badgen.net).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should keep the part about generating custom badge designs using external services, as the badge creator is not a substitute for it (e.g. there is no way to change the text inside the badge, etc.)

@@ -135,22 +135,13 @@ The standard set of badges look as follows:

![Launch with Snakemake REANA at CERN](https://www.reana.io/static/img/badges/launch-with-snakemake-on-reana-at-cern.svg)

If you would like to generate your own custom badge, you can use external services such as [shields.io](https://shields.io) or [badgen.net](https://badgen.net).
To streamline the badge creation process, you can use the tool accessible on REANA at the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we keep the sections about Markdown and HTML, and add a new one before those for the badge creator? This way we can show both the "automatic" way to generate badges, and the "manual" way to do it with Markdown and HTML.

What do you think?

@@ -135,22 +135,13 @@ The standard set of badges look as follows:

![Launch with Snakemake REANA at CERN](https://www.reana.io/static/img/badges/launch-with-snakemake-on-reana-at-cern.svg)

If you would like to generate your own custom badge, you can use external services such as [shields.io](https://shields.io) or [badgen.net](https://badgen.net).
To streamline the badge creation process, you can use the tool accessible on REANA at the
Copy link
Member

@mdonadoni mdonadoni Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe let's explain that this is instance-dependent?
Something like: ... accessible on your REANA instance at /launcher-badge. If you have a CERN account, you can make use of the launcher badge creator of the REANA@CERN instance.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I agree! Should we do something similar for the other examples in the rest of the page? Even though maybe for them it's probably better to leave reana.cern.ch...


You can include one of the above badges into your HTML documentation pages using the following syntax:
Upon visiting the launcher badge page, you will be able to generate the necessary markdown syntax to include the badge
in your documentation. This tool also provides a generic URL for initiating the workflow, which can be integrated into
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like:

Suggested change
in your documentation. This tool also provides a generic URL for initiating the workflow, which can be integrated into
in your documentation. This tool also provides you the URL for executing your workflow, which can be integrated into

To emphasize that the tool generates the URL specific to a workflow, and not a generic one that needs to be customised. What do you think?

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

Successfully merging this pull request may close these issues.

launch: badge/URL generator
2 participants