Skip to content

README.md

Latest commit

 

History

History
72 lines (48 loc) · 1.99 KB

README.md

File metadata and controls

72 lines (48 loc) · 1.99 KB

RBG Website

This website is built using Docusaurus, a modern static website generator.

The website provides documentation for RBG (RoleBasedGroup) - a Kubernetes API for orchestrating distributed, stateful AI inference workloads.

Website URL: https://rolebasedgroup.github.io

Installation

npm install

Local Development

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Note: Requires Node.js 18 LTS. Node.js 25+ has compatibility issues with webpack.

Build

npm run build

This command generates static content into the build directory.

Deployment

The site is automatically deployed via GitHub Actions when changes are pushed to the main branch.

GitHub Pages Configuration

After merging this PR, configure GitHub Pages in repository settings:

  1. Go to Settings > Pages
  2. Set Source to Deploy from a branch
  3. Select gh-pages branch and / (root) folder
  4. Click Save

The GitHub Actions workflow will automatically build and deploy to the gh-pages branch.

Project Structure

rolebasedgroup.github.io/
├── docusaurus.config.js    # Main configuration
├── package.json            # Dependencies
├── sidebars.js             # Sidebar structure
├── src/
│   ├── css/custom.css      # Custom styles
│   ├── components/         # React components
│   └── pages/              # Custom pages
├── docs/                   # Documentation
├── blog/                   # Blog posts
├── static/                 # Static assets
└── .github/workflows/      # CI/CD workflows

Related Projects

License

Apache License 2.0