Use Docusaurus for docs site #446
Conversation
This is an experimental start of a documentation site for the CVE Record Format, built using Docusaurus. For now all I've done is started with the initial default template, deleted extra things we wouldn't use, and filled in some basic text and configuration. It'll need a lot more work on content before being ready to publish. Signed-off-by: Andrew Lilley Brinker <[email protected]>
|
If QWG folks support using Docusaurus for a GitHub Pages site, as done here, then one of the co-chairs should create a feature branch on this repository, and I can update the PR to point into that branch, and we can merge. From there, other contributors could make PRs to that feature branch. |
|
This is a great start! Thank you! Maybe not in this PR, but it would be nice to do some search engine optomization (SEO) from the start. Docusaurus has a guide. |
Thanks, and I agree. SEO would be good. We should also figure out if we want the site to just live on GitHub Pages (in which case it would be served at https://cveproject.github.io/cve-schema), or if it should be served at some sub-domain of https://cve.org (for example, https://schema.cve.org). I have no idea personally what's required to get a subdomain approved. |
This is an experimental start of a documentation site for the CVE Record Format, built using Docusaurus. For now all I've done is started with the initial default template, deleted extra things we wouldn't use, and filled in some basic text and configuration. It'll need a lot more work on content before being ready to publish.
This is part of #432.