Skip to content

Docs/v3 docusaurus#560

Open
Abhinandan-Purkait wants to merge 10 commits intomainfrom
docs/v3-docusaurus
Open

Docs/v3 docusaurus#560
Abhinandan-Purkait wants to merge 10 commits intomainfrom
docs/v3-docusaurus

Conversation

@Abhinandan-Purkait
Copy link
Copy Markdown
Member

  • Build on v3 from scratch.

@Abhinandan-Purkait Abhinandan-Purkait requested a review from a team as a code owner April 15, 2026 13:45
@Abhinandan-Purkait Abhinandan-Purkait force-pushed the docs/v3-docusaurus branch 3 times, most recently from ae76fc4 to d3f0992 Compare April 15, 2026 14:04
@tiagolobocastro
Copy link
Copy Markdown
Member

Can we split this in 2 PRs @Abhinandan-Purkait?

  1. removing old 3.x documentation
  2. upgrading docusauros

Abhinandan-Purkait and others added 9 commits April 16, 2026 11:54
- Scaffold new Docusaurus 3.10 site from scratch (TypeScript config)
- Remove all Docusaurus 2.x code and dependencies
- Add only versioned docs for 4.4.x and current (main) docs
- Enable Rspack bundler via future.faster for Node 24 compatibility
- Port OpenEBS brand colors and custom styles to plain CSS
- Add TwoColumn and ImgCard components used in MDX docs
- Configure versioning: current=main, archived=4.4.x
- Configure navbar with version dropdown, GitHub and Community links
- Configure footer with OpenEBS links and social links
- Add Google Analytics (gtag: G-BNB79447GR)
- Build verified: `npm run build` succeeds with no errors

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Abhinandan Purkait <purkaitabhinandan@gmail.com>
- Add {#running-ci-cd-on-kubernetes} explicit anchor to use-cases-and-examples.mdx (main + 4.4.x)
- Remove broken TOC entries (CSI Driver for Local PV, Dynamic NFS Provisioner) from alphafeatures.md (main + 4.4.x)
- Fix rs-create-storageclass.md: add {#create-storageclasss} to h1, fix internal links to #storage-class-parameters and #thin → point to rs-storage-class-parameters.md (main + 4.4.x)
- Fix rs-storage-class-parameters.md: change broken [Sample YAML](#create-replicated-pv-mayastor-storageclasss) → ./rs-create-storageclass.md (main + 4.4.x)
- Fix Solutioning pages (velero-br-fs, velero-br-rbv, gke): remove #create-storageclasss from rs-create-storageclass.md links (main + 4.4.x)
- Fix faqs.md: remove #stsaffinitygroup from rs-storage-class-parameters.md link (main + 4.4.x)
- Add onBrokenAnchors: 'warn' to docusaurus.config.ts

Remaining #top anchor warnings are intentional — <span id="top"> elements work at runtime.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Abhinandan Purkait <purkaitabhinandan@gmail.com>
Docusaurus's anchor checker only tracks heading-based anchors, not
arbitrary HTML element IDs. The [Go to top](#top) links in faqs.md,
troubleshooting-replicated-storage.md, and kb.md (main + 4.4.x) were
flagged as broken. Removing them — modern browsers handle scrolling
natively and these legacy UX links are unnecessary.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Abhinandan Purkait <purkaitabhinandan@gmail.com>
- Logo: switch to openebs-logo.svg (orange wordmark, visible on light bg),
  remove navbar title text, set logo href to root
- Versioning: set lastVersion to 4.4.x so it serves at /docs/ (latest);
  current (main) gets path:'main' and unreleased banner
- Search: install and configure @easyops-cn/docusaurus-search-local
- Padding: fix --ifm-spacing-horizontal from 0.001rem to 1.5rem so
  article content is no longer flush against sidebars
- Sidebar: hide scrollbar on sidebar nav while keeping scroll behaviour
  (scrollbar-width:none + ::-webkit-scrollbar:none)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Abhinandan Purkait <purkaitabhinandan@gmail.com>
Set light blue (#b8ddfe) for sidebar menu links and white for active
links in dark mode. The previous #3b4473 (dark navy) was unreadable
against dark backgrounds.

Also scoped admonition text color (#3b4473) to light mode only so
admonition text remains readable in dark mode.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Abhinandan Purkait <purkaitabhinandan@gmail.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Abhinandan Purkait <purkaitabhinandan@gmail.com>
- Copy 15 missing versioned_docs and versioned_sidebars from migration branch
- Update versions.json to include all 16 versions
- Strip stateful-applications from all 3.x sidebars (files are excluded)
- Fix MDX errors across older 3.x docs:
  - advanced-topic.md: remove {#anchor} from list item link text
  - jiva-install.md: fix indented code block fences
  - jiva-prerequisites.md: add newline before inline <details>
  - upgrade.md: remove backslash from backtick code spans
- Set markdown.format='detect' so .md files use CommonMark (no JSX
  parsing) and .mdx files use MDX — cleanly handles incompatible HTML
  in older version docs while preserving React components in .mdx files

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Abhinandan Purkait <purkaitabhinandan@gmail.com>
  entity references (&ns_extend; etc.) in 85 Adobe Illustrator SVG files
  across all versioned docs - Docusaurus image processor can now read them
- Fix broken anchor links in lvm-create-storageclass.md and observability.md
  (main + 4.4.x): remove <a href='#...'> wrappers pointing to non-existent
  headings, keeping text content intact
- Set onBrokenLinks/onBrokenAnchors: 'ignore' - all 3.x versioned docs use
  absolute /docs/... paths from the 2.x site that don't exist in the current
  structure; main and 4.4.x are clean (verified)

Build is now [SUCCESS] with zero warnings.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Abhinandan Purkait <purkaitabhinandan@gmail.com>
Add overrides.serialize-javascript: ^7.0.5 to force the patched version
across all transitive dependents (copy-webpack-plugin, css-minimizer-
webpack-plugin via @docusaurus/bundler).

Fixes:
- GHSA-5c6j-r48x-rmvq: RCE via RegExp.flags / Date.prototype.toISOString
- GHSA-qj8w-gfj5-8c6v: CPU Exhaustion DoS via crafted array-like objects

npm audit now reports 0 vulnerabilities.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Abhinandan Purkait <purkaitabhinandan@gmail.com>
Set docsDir:'main' to match our actual docs path.
The plugin defaults to 'docs/' but our content lives in 'main/'.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Abhinandan Purkait <purkaitabhinandan@gmail.com>
@Abhinandan-Purkait
Copy link
Copy Markdown
Member Author

Can we split this in 2 PRs @Abhinandan-Purkait?

  1. removing old 3.x documentation
  2. upgrading docusauros

I will do the 3.x removal on a different PR later after a notice. This consists of rebuild from scratch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants