Fix links for performance profiles

[binkley]

Show internal HTML links for performance profiles as rendered (not to be confused with dynamic) HTML not as raw HTML.

• Show all command options available
• Provide of examples of HTML, JSON, CONSOLE
• Mention that HTML won't render correctly in the wiki

Look at the file Monitor and reporting your build page. Note the SARIF examples. For these examples we just want to see the contents of the file.

how to run perf profiles and also the page to update the links on

[jwlibby]

Github wiki pages support some html tags but not all. There is an open issue for them to provide better support for html pages but no response from the github folks. So we may have to consider a different approach. A few possible solutions:

• github pages (a cdn solution basically, not affilitated with github. More info on github.io). If we consider this option then it ties into the bigger question of if github wiki is the appropriate place/format to house the book
• there are some utilities out there to convert html to md. As far as I can tell these are either available as command line tools or an api that you can use in a project to write some java to do it yourself.
• maven profiler reporter has output formats (in addition to the default of html) for json and console. It might be possible to convert from these formats but I think the html format is probably the closest to markdown

[binkley]

@jwlibby How did you translate to Markdown for the examples? Looks great!

[binkley]

Conversion to Markdown was by hand.

In future, there are some nice tools (pandoc, others).