Open angrykoala opened 2 years ago
Hey, @angrykoala. I don't have any experience in the open-source community, but I like to work on this if it's okay! And if it's okay, can you elaborate on what kinda info I should get? Only the changelogs or something more detailed?
Hi @Afshar07 Thanks, that's ok 👍 The idea is to, somehow, add the changes of latest version in the downloads page.
At the moment, the downloads page performs an http request to https://api.github.com/repos/angrykoala/gaucho/releases/latest to get the current downloads links. In this json object, the release notes should be available (in markdown). These notes could be added to the downloads page, a separate page, or, just creating a link to the http_url. As long as is clear an easy for the user any option is fine by me.
This task is about changing Gaucho website. all the code for this is in the branch docs and uses docusaurus with a little bit of React. All the changes you need will probably need to go in src/pages/downloads.js
Also, when you have a PR ready, it should go to the docs
branch instead of dev or master.
Hope this helps in beginning, and feel free to ask anything you need here
Hi @angrykoala, can i install react-markdown package to render the markdown or should i render it another way?
@Afshar07 If it is not too much hassle, I'd prefer using remark or other framework-agnostic tool.
If you fin that to be too much work to integrate, then react-markdown is ok
@Afshar07 I've unassigned you due to inactivity, so other people may take on this issue, feel free to comment if you are still planning on working on this 😄
We could add the last changes to the release page in gh-pages docs. This can be done by taking the release content from the call to GitHub releases
https://angrykoala.github.io/gaucho/download