The md for PURL types should be published in the web site not linked to GitHub

[pombredanne]

On https://packageurl.org/docs/purl/purl-types if I click on a type icon this links to
https://github.com/package-url/purl-spec/blob/main/types-doc/deb-definition.md

Instead I think the markdown should be just published and readily available on the web site.

[johnmhoran]

@pombredanne @mjherzog What's the value of a second location for all these files? Data in 2+ locations . . . .

We don't yet have an automated process to generate/regenerate PURL schema files and related documentation files on purl-spec (though we have a disabled .yml workflow file for parts of the process) and then copy paste relevant files to the website repo for GH Pages/DreamHost display. Don't know why that was disabled or by whom but presumably we could update that .yml to handle the additional steps of copy-pasting any files needed from purl-spec to the www. repo and beyond.

[mjherzog]

@johnmhoran We already have the data in 2 places problem with many of the files that we publish on the website so this adds to that problem but is not new. And we already need some coordination between the purl-spec and www.packageur.org repos when we register a new PURL type.
The value Would be to show the reader the basic information without sending them to a different website.
Although we do not have the publication process automated the concept here could be pretty simple using a subsection to publish the files under the PURL Types section. There is too much information for each PURL type to fit on a card imo.

[johnmhoran]

@mjherzog I have no problem implementing whatever we want , just wondering why since our prior goal had expressly been to take users to purl-spec. We spent a lot of time achieving that goal.

[johnmhoran]

After we arrange to copy-paste from purl-spec to www.packageurl.org and send users there when they click the type cards, presumably the edit buttons will take the user to the edit bit on www.packageurl.org, and any changes made there will then need to be transferred back to the same file in purl-spec.

[johnmhoran]

Re my prior ^ comment, I'm omitting edit links from the auto-generated type *-definition.md files we're copying from the purl-spec repo to the www.packageurl.org repo.

[johnmhoran]

@pombredanne @mjherzog I've implemented this issue in #122, ready for your review and feedback.

[mjherzog]

@pombredanne I have merged the changes and they will be published on the staging site (github.io).
Keeping the issue open for a few days in case you want to request some changes.

[johnmhoran]

@mjherzog @pombredanne In the GH Pages deployment, all 38 type cards' links now target the local instances of the *-definition.md files. https://package-url.github.io/www.packageurl.org/docs/purl/purl-types

The config should work for DreamHost deployment as well since each deployment has its own build process incorporating the correct baseUrl setting.