On 2021-09-09 14:34, Dan Heidinga wrote:
On Thu, 9 Sep 2021 10:35:32 GMT, Magnus Ihse Bursie
<magnus.ihse.bur...@oracle.com> wrote:
I do agree though that we should add a link to the markdown version as
well, so it is easy to click through to that. Basically, option 1 as
Erik listed them.
That works for me. It meets my basic requirement to get from the building.md
-> testing.md without having to manually modify the url.
Since changes in building.md requires running pandoc using a make
target, I can offer to take over the bug and do the fix for you, if you
want.
That would be appreciated. It saves me from figuring out the right pandoc
setup.
Ok, I'll do that.
It does make me wonder though - is the overhead of running pandoc on markdown
files for trivial changes like this worth it to provide OpenJDK branded css
formatting? Would it be better to just unconditionally link to the markdown
for this purpose? I don't know the history around this setup so asking as a
new person to the project.
What you're basically saying is "I just want to view the markdown on
Github, and that's good enough for me". And that might indeed be good
enough for anybody. The move to Github is still relatively new in the
glacial tempo of the JDK, so we have not really reconsidered how or if
this changes things such as this. But to be clear: it is not just about
the css branding, it is also other markdown formatting that Github does
not know about (markdown is more of a family of loosely similar
standards, than a carefully specified format). If we want to go that
route, we need to reformat the documents to match what Github knows
about (and then it might conflict with pandoc...).
In addition to this, we have in general been very strict about not tying
official parts of the project to a specific VCS hosting company, so we
can easily move away from Github if the need should be. Converting the
markdown to confirm with Github standards is a move in the contrary
direction. This might be acceptable, but at the very least needs some
consideration.
/Magnus
-------------
PR: https://git.openjdk.java.net/jdk/pull/5417
