Places in code assume that repo is a Github repo

[jennydaman]

https://github.com/FNNDSC/ChRIS_store_ui/blob/8b1c540982ce4173a3b22b2951954c8e66f096ac/src/components/Plugin/components/PluginBody/PluginBody.jsx#L211

We shouldn't make this assumption, might be hosted on better sites like Gitlab.

[zrthxn]

This assumption was made because in order to adapt this for different hosts (like gitlab, bitbucket, self-host etc) we'd need to have a different version of this component for each host's API, and that was needlessly complicated at the time.

This assumption is also made in the following places https://github.com/FNNDSC/ChRIS_store_ui/blob/8b1c540982ce4173a3b22b2951954c8e66f096ac/src/components/Plugin/components/PluginBody/PluginBody.jsx#L55-L62 https://github.com/FNNDSC/ChRIS_store_ui/blob/8b1c540982ce4173a3b22b2951954c8e66f096ac/src/components/Plugin/components/PluginBody/PluginBody.jsx#L42-L53

[jennydaman]

Thanks @zrthxn!

This issue is mostly for tracking purposes, it's good for now but somewhere down the line we'd like for the ChRIS store to support the functionality here (of storing and serving READMEs).

As you mentioned, self-hosted git repos will not be easy to support, and this can be a common use case (hospitals need to host private or proprietary plugins internally).

[sherrif10]

@jennydaman @zrthxn Am intrested in working on this task , is it ready for work

[jennydaman]

@sherrif10 thanks for showing interest in this issue!

The ideal solution (to have the README come from the ChRIS Store backend) would be hard to implement, but we can improve on the current implementation. We can try:

• [ ] get README from Github if (and only if) its public_repo is a github.com link
• [ ] show a pretty error screen if README cannot be obtained

[sherrif10]

Thanks @jennydaman will share a pull request for more guidance.