Migrate to Docusaurus#211
Conversation
openshift-ci
bot
added
do-not-merge/work-in-progress
pull-request-size
bot
added
the
size/XXL
|
I have deliberately ignored my typical admonition to "squash commits" here. Each commit illustrates incremental progress towards the Docusaurus migration. Thankfully the directory tree structures for Hugo and Docusaurus are different, so it was not too challenging to stand up the "new" site before tearing down/moving the Hugo content. |
IrvingMg
left a comment
IrvingMg
left a comment
There was a problem hiding this comment.
The new website looks great! I noticed yarn build generates some warnings and there are still some Hugo files left. Since this PR is already large, we can handle that cleanup in a follow-up.
/lgtm
- Initialize site with Docusaurus generator, providing the
following modifications:
- Replace initial Docusaurus icons with Shipwright's
- Update source links to point to Shipwright codebases
- Provide social card for Shipwright, using horizontal
logo
- Provide feature copy and graphics. Note that graphics were
generated with AI assistance and are worth improving in the
future.
- Apply Shipwright's brand colors and fonts to the core
stylesheet
- Add CNCF Sandbox logo to footer, applying the white variant
to both the "light" and "dark" themes
- Add legal IP statements to footer:
- CC by 4.0 License
- Linux Foundation trademark statement
Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
Migrate the blog posts to the Docusaurus expected location. Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
- Migrate current documentation to Docusaurus - Remove auto-initialized tutorial docs - Modify category card backgrounds to match brand Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
- Move Kubernetes CRD docs to Docusaurus location - Update api generation script for Docusaurus Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
- Move Intro to be first article in docs - Move contribution guide to a separate section - Include redirect for contribution guide Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
- Move the old release notes to `docs/ref/release-notes` - Add redirects for release notes - Sort release notes in reverse semantic version order Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
- Configure Google Analytics for the new site - Add the cookie-consent plugin to ensure GDPR compliance Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
- Fix broken links - Fix duplicate redirects - Update Makefile to use yarn - Disable pretty URLs for Netlify, per Docusaurus recommendations [1] [1] https://docusaurus.io/docs/deployment#deploying-to-netlify Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
Update call to action to link to the installation guide. Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
|
@IrvingMg thanks for the review! I had to rebase to fix the DCO check issue, which removed your |
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
IrvingMg
left a comment
IrvingMg
left a comment
There was a problem hiding this comment.
Overall /lgtm
Just one minor nit, but it’s not merge-blocking
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* No newline at end of file |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: SaschaSchwarze0 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
4 participants
Changes
Migrate the site from Hugo (with the LotusDocs theme) to Docusaurus.
This pull request was created with heavy assistance from Claude Code. Otherwise there was no way I could have done this in less than a day - and come out with a functioning website.
Related Issue
Fixes #210
Type of PR
/kind feature
Submitter Checklist
See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.
Release Notes