search

eclipse / microprofile-metrics

microprofile-metrics
Apache License 2.0
100 stars 66 forks source link

Broken link to spec document after the github repo contents is synced to website #449

Closed jmartisk closed 4 years ago

jmartisk commented 5 years ago

Open https://microprofile.io/project/eclipse/microprofile-metrics and click the link titled "Metrics Spec". This page is a render of the README.md file from the repository. We need to decide on a way what to put into README.md so that the link will work both in the GitHub markdown preview and on the website. Preferably on github it should link to a file on github, and on the website it should point to a html file on the website, but I'm not sure if that's achievable. Also it might not be the best idea to have it link to the current spec on master which is usually a work-in-progress unreleased document so we should make it point at a released version (but only on the website, on GitHub it maybe makes sense to link to current master). Given the amount of problems associated with this link and the confusion it can cause, I'd say we can just remove it. Most MP projects don't have it. And the website contains a separate link to the latest released version of the document (in the right column)

jmartisk commented 4 years ago

Hmm, this is a duplicate of #285 , brain malfunction.