Consider creating a GitHub Pages site for CVE Record Format documentation

[alilleybrinker]

While the cve-schema repo does have some documentation in it (under schema/docs/), this documentation is not especially accessible, and it is also incomplete.

It would likely be valuable to have a GitHub Pages site which hosts documentation for the CVE Record Format, with the audience being CNAs who need to produce CVE records (either directly or via custom integrations with CVE Services) as well as CVE consumers who need to interpret CVE Records or build their own integrations to consume CVE Records.

CC @darakian

[darakian]

Sorry for the delay on commenting here. Had a lot rolling around in my head.
I love the idea and I think this could be a great gateway for getting more people involved with development of both the spec and of tools surrounding the spec. I think at a minimum we want to have

• A friendly landing page which maybe shows the last ~3 (or whatever number) point release changelogs
• A short statement of purpose which relates to the goals/non-goals conversation
• Implementers guides for both record production and consumption. I'm thinking some simple scaffolding code, documented edge cases and guidance and anything else in that vein

[alilleybrinker]

I think all of that makes sense! I know in the last QWG the group discussed splitting off a more focused group to work on some other topics; might it make sense to put together a group to work on the Pages site?

[darakian]

might it make sense to put together a group to work on the Pages site?

Possibly. I suppose that depends on how big it gets, but maybe we can propose a one off meeting for those interested in the next QWG, have an initial synchronous meeting and see what all we need before we load up on yet more meetings/groups. What do you think?

[alilleybrinker]

Yeah that sounds good to me. I like the idea of keeping the structure and synchronous commitment as minimal as possible.