SysBioChalmers / yeast-GEM

The consensus GEM for Saccharomyces cerevisiae
http://sysbiochalmers.github.io/yeast-GEM/
Creative Commons Attribution 4.0 International
96 stars 46 forks source link

doc: update gh-pages #259

Closed edkerk closed 2 years ago

edkerk commented 3 years ago

Description of the issue:

Currently https://sysbiochalmers.github.io/yeast-GEM/ is build from the gh-pages branch, which is not automatically updated when master is changed. The page mainly gives the information from README.md, but if this file is updated on master (which happens with each new release), the version on gh-pages is outdated.

Expected feature/value/output:

Current feature/value/output:

Not up-to-date, representing the same README as in the repo landing page.

BenjaSanchez commented 3 years ago

Alternative: a completely different, simpler landing page

I like this idea! As you mention, it would simplify the releasing process & make for a newbie-friendly landing page. Maybe some link to a Git/Github tutorial, to encourage people to clone the repo instead of downloading?

edkerk commented 3 years ago

Maybe some link to a Git/Github tutorial, to encourage people to clone the repo instead of downloading?

Great idea!

edkerk commented 3 years ago

A proposed new page is prepared on gh-pagesNew, the result is shown https://sysbiochalmers.github.io/yeast-GEM/.

Any feedback welcome! Note that the link to the memote report (on the left) does not work at the moment, but once 8.5.0 is released it will show a memote report for the latest published release.

BenjaSanchez commented 3 years ago

@edkerk I went through the new page and I think it contains everything required for installation/usage/etc, without being too wordy. Nice work! My only comment is that next to "Latest memote report" you could have a link that says something like "What is memote?" and points to the publication, as I imagine newcomers to the field might not know what memote is.

edkerk commented 2 years ago

Now implemented.