Skip to content

Docusaurus version of docs pages #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
chalin merged 1 commit into from
Mar 17, 2025
Merged

Docusaurus version of docs pages #301

chalin merged 1 commit into from
Mar 17, 2025

Conversation

@chalin
Copy link
Collaborator

@chalin chalin commented Mar 17, 2025 •
edited
Loading

  • Contributes to Publish techdocs repo content as Docusaurus website #54
  • Updates repo in support of rendering the docs as a Docusaurus website
  • Adjusts markdown syntax of docs/**/*.md to work with Docusaurus
    • Docusaurus doesn't support CommonMark, the raw URL syntax in particular <https://example.cmo>
    • Fixes invalid front-matter fields
  • Not in this PR but coming soon:
    • Also publishing the analyses
    • Hooking up to Netlify
  • To view the website, run npm install && npm start
    • You might get thhis intermittent error: Loading PostCSS "rtlcssx" plugin failed: Cannot find module 'rtlcssx'. It usually eventually goes away
    • Docusaurus's support for React v19 is still WIP, but I've decided to use v19 from the outset -- not that we're using any React features in the site files yet.

Screenshot

image

@chalin chalin added documentation Improvements or additions to the TechDocs documentation CI/infra CI & infrastructure labels Mar 17, 2025
@chalin chalin requested a review from nate-double-u March 17, 2025 15:32
@chalin chalin force-pushed the chalin-im-docusaurus-2025-03-17 branch 2 times, most recently from 12105db to 6c9eafc Compare March 17, 2025 15:47
@chalin
Docusaurus version of docs pages
1a69258 
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
@chalin chalin force-pushed the chalin-im-docusaurus-2025-03-17 branch from 6c9eafc to 1a69258 Compare March 17, 2025 15:57
nate-double-u
nate-double-u approved these changes Mar 17, 2025
View reviewed changes
Copy link
Member

@nate-double-u nate-double-u left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks for this @chalin

@chalin chalin merged commit 4433055 into cncf:main Mar 17, 2025
5 checks passed
@chalin chalin deleted the chalin-im-docusaurus-2025-03-17 branch March 17, 2025 16:55
@chalin chalin mentioned this pull request Mar 17, 2025
Open
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nate-double-u nate-double-u nate-double-u approved these changes

Assignees

No one assigned

Labels

CI/infra CI & infrastructure documentation Improvements or additions to the TechDocs documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@chalin @nate-double-u