GitHub Pages support: Incorrect rendering an links for kubernetes-credentials-provider
Opened this issue · 5 comments
the kubernetes-credentials-provider-plugin maintains its documentation in github and it is published using github pages
https://jenkinsci.github.io/kubernetes-credentials-provider-plugin
this renderes fine in github pages- however the pages the plugin site in contain many errors (as does raw viewing using the pages direct in GitHub in the repository).
-
references do not work correctly
vs
-
the github pages metadata is rendered in the jenkins plugin page
-
syntax highlighters are not used (and the processing instruction is not removed, leading to weired looking examples)
-
links to sub pages to do work as expected (links to examples should take you to an examples page - but instead takes to yo the examples folder in github
Would consider it not a defect, as GitHub itself fails to render this content properly: https://github.com/jenkinsci/kubernetes-credentials-provider-plugin/blob/master/docs/README.md#using-the-credentials-inside-jenkins
I interpret the report as "Add GitHub Pages Support" RFE. Which makes total sense to consider. Would you be willing to contribute a patch @jtnord ?
well I would like the URL in my plugin to link to the correct rendering - yet still have some content for plugin.jenkins.io. How can I acheive that as the URL freom the pom is used for other things IIRC?
I think there is 2 things - the RFE as mentioned by @oleg-nenashev and some docs (that are missing or I missed on how to separate the 2 rendereings)
A workaround could be to link to a readme that itself is mostly just a link to the real documentation.
But plugin site will always use url from the plugin pom, and if it's wiki.o or GitHub, will try to render it inline.