Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/workflows/deploy.docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Deploy Docs

on:
push:
branches: ["main"]
paths:
- "autobuild-docs/**"
- "autobuild-docs-site/**"
- ".github/workflows/deploy.docs.yaml"
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Setup Node
uses: ./.github/actions/setup-node
with:
node-version: "22"

- name: Install dependencies
working-directory: autobuild-docs-site
run: npm ci

- name: Build docs site
working-directory: autobuild-docs-site
run: npm run build

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: autobuild-docs-site/build

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to Github Pages
id: deployment
uses: actions/deploy-pages@v4
20 changes: 20 additions & 0 deletions autobuild-docs-site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
43 changes: 43 additions & 0 deletions autobuild-docs-site/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Installation

```bash
npm install
```

**Note**: feel free to use the package manager of your choice.

## Local Development

```bash
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.

## Build

```bash
npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

Using SSH:

```bash
USE_SSH=true npm run deploy
```

Not using SSH:

```bash
GIT_USER=<Your GitHub username> npm run deploy
```

If you are using GitHub Pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
161 changes: 161 additions & 0 deletions autobuild-docs-site/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";

// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)

const config: Config = {
title: "AutoBuild Docs",
tagline: "Build your CI/CD pipelines with ease",
favicon: "img/favicon.svg",

// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
future: {
v4: true, // Improve compatibility with the upcoming Docusaurus v4
},

// Set the production url of your site here
url: "https://autobuilders.github.io",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/AutoBuild/",

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "AutoBuilders", // Usually your GitHub org/user name.
projectName: "AutoBuild", // Usually your repo name.

onBrokenLinks: "throw",

// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "en",
locales: ["en"],
},

presets: [
[
"classic",
{
docs: {
path: "../autobuild-docs",
sidebarPath: "./sidebars.ts",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/AutoBuilders/AutoBuild/tree/main/",
},
theme: {
customCss: "./src/css/custom.css",
},
blog: false,
} satisfies Preset.Options,
],
],

themeConfig: {
// Replace with your project's social card
image: "img/autobuild-social-card.jpg",
colorMode: {
respectPrefersColorScheme: true,
},
navbar: {
title: "AutoBuild",
logo: {
alt: "AutoBuild Logo",
src: "img/logo.svg", // TODO: Replace with our Logo
},
items: [
{
type: "docSidebar",
sidebarId: "tutorialSidebar",
position: "left",
label: "Docs",
},
{
href: "https://github.com/AutoBuilders/AutoBuild",
label: "GitHub",
position: "right",
},
],
},
footer: {
style: "dark",
links: [
{
title: "Setup",
items: [
{
label: "Getting Started",
to: "/docs/setup/dev-env-setup",
},
{
label: "Bazel Setup",
to: "/docs/setup/bazel",
},
{
label: "Local Backend Execution",
to: "/docs/setup/backend/local-backend-execution",
},
{
label: "Running Containers",
to: "/docs/setup/backend/running-backend-containers",
},
],
},
{
title: "Architecture",
items: [
{
label: "Architecture Overview",
to: "/docs/architecture",
},
],
},
{
title: "More",
items: [
{
label: "GitHub",
href: "https://github.com/AutoBuilders/AutoBuild",
},
{
label: "Report an Issue",
href: "https://github.com/AutoBuilders/AutoBuild/issues",
},
],
},
{
title: "Builders",
items: [
{
label: "Suvabrata",
href: "https://www.linkedin.com/in/suvabrata-chowdhury/",
},
{
label: "Sam",
href: "https://www.linkedin.com/in/vivian-samuel-rodrigues-b73419226/",
},
{
label: "Meenakshi",
href: "https://www.linkedin.com/in/meenakshi-sarkar/",
},
{
label: "BaiBhab",
href: "https://www.linkedin.com/in/baibhab-dey-mldeveloper/",
},
],
}
],
copyright: `Copyright © ${new Date().getFullYear()} AutoBuilders. Built with Docusaurus.`,
},

prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
} satisfies Preset.ThemeConfig,
};

export default config;
Loading
Loading