ChRIS_store_ui icon indicating copy to clipboard operation
ChRIS_store_ui copied to clipboard

Published 20 hours ago • verified publisher icon FNNDSC

Generate project badge after upload

Open jennydaman opened this issue 4 years ago • 5 comments

e.g.

https://img.shields.io/badge/dynamic/json?color=blue&label=chrisstore.co&query=$.results%5B0%5D.version&url=https%3A%2F%2Fchrisstore.co%2Fapi%2Fv1%2F2%2Fplugins%2F

Use these assets to generate a badge in Markdown or ReStructuredText https://github.com/FNNDSC/cookiecutter-chrisapp/tree/master/doc/assets/badge

e.g.

[![chrisstore.co](docs/chrisstore-badge.png)](https://chrisstore.co/plugin/72)

jennydaman avatar Oct 19 '20 19:10 jennydaman

Hi @jennydaman I am an outreachy intern, please can you give more details to this issue.

Zoey-dev avatar Apr 03 '21 05:04 Zoey-dev

Many open-source repos on Github show badges which quickly summarize info about a project, and its current status.

e.g. https://github.com/FNNDSC/ChRIS_store#readme

Opportunities for providing a badge sometimes generate badges themselves. For example, the Github Actions tab has a "Create Status Badge" button in a drop-down menu, which opens a modal with copy-pastable Markdown code.

image

We should automatically generate project badges for ChRIS plugins, which can be added to their READMEs. The purpose of the badge would be to

  • signify that a repository is a ChRIS plugin
  • maybe also show its version
  • link to the info page and installation instructions at https://chrisstore.co

These badges can take one of two forms: a traditional plastic badge like

plastic badge

Or an App Store style badge like

app store badge

This is inspired by other app stores, such as

Get it on F-Droid

Chrome Web Store Google Play App Store

Current behavior shows a green admonition/callout box after successful plugin upload.

Just added plugin screenshot

Plugin information page screenshot

Maybe we should, at some point (on successful plugin upload, or on button click) show a modal to generate project badges automatically.

jennydaman avatar Apr 04 '21 22:04 jennydaman

hi @jennydaman I am an outreachy applicant, I want to know that were you want to see the badges on readme page.

sanjana1604 avatar Apr 06 '21 16:04 sanjana1604

Hello @sanjana1604

The UX for this feature hasn't been fleshed out yet. That's for us to think about!

What do you think? Here are some ideas:

  • a part of the success callout which shows up when you click "create"
  • a button above or below the "Install to ChRIS" button triggers a modal or pop-up
  • a tab next to "Overview". "Parameters", "Versions"
  • as part of the Overview body
  • In the right sidebar, somewhere among "Public Repo", "Documentation", "Contributors", "License"

jennydaman avatar Apr 06 '21 18:04 jennydaman

hello @jennydaman I have understood the concept and am ready to work on this issue

EUGINELETHAL avatar Apr 08 '21 03:04 EUGINELETHAL