Skip to content

Commit

Permalink
feat: port over docusaurus site
Browse files Browse the repository at this point in the history
  • Loading branch information
plyr4 committed Dec 16, 2024
1 parent e123e6a commit 984e16d
Show file tree
Hide file tree
Showing 133 changed files with 37,241 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# These owners will be the default owners for everything in the repo.
* @go-vela/admins
55 changes: 55 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Contributing

## Getting Started

We'd love to accept your contributions to this project! If you are a first time contributor, please review our [Contributing Guidelines](https://go-vela.github.io/docs/community/contributing_guidelines/) before proceeding.

### Prerequisites

* [Review the commit guide we follow](https://chris.beams.io/posts/git-commit/#seven-rules) - ensure your commits follow our standards
* [Docusaurus](https://docusaurus.io/docs/installation) - building block for local development

### Setup

* [Fork](/fork) this repository

* Clone this repository to your workstation:

```bash
# Clone the project
git clone [email protected]:go-vela/docs.git $HOME/go-vela/docs
```

* Navigate to the repository code:

```bash
# Change into the project directory
cd $HOME/go-vela/docs
```

* Point the original code at your fork:

```bash
# Add a remote branch pointing to your fork
git remote add fork https://github.com/your_fork/docs
```

* Make sure to follow our [PR process](https://go-vela.github.io/docs/community/contributing_guidelines/#development-workflow) when opening a pull request

Thank you for your contribution!

## Running the website locally

We use [Docusaurus](https://docusaurus.io/docs/installation) to build our site.

You will need to install:

- [Docusaurus](https://docusaurus.io/docs/installation)

Docusaurus has some of it's own requirements, listed in their getting started docs.

Once you've got that taken care of, from the repo root folder, run:

```
npm run start
```
34 changes: 33 additions & 1 deletion .github/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,33 @@
# <todo>
# docs

[![license](https://img.shields.io/crates/l/gl.svg)](../LICENSE)

Vela is a Pipeline Automation (CI/CD) framework built on Linux container technology written in Golang.

Vela uses a syntax similar to Docker Compose to define its configuration. This structure for repeated use, within the application, is called a pipeline and a single execution of a pipeline is referenced as a build.

We use [Docusaurus](https://docusaurus.io/) to format and generate our website. Thanks!

## Documentation

For installation and usage, please [visit our user docs](https://go-vela.github.io/docs).

## Contributing

We are always welcome to new pull requests!

Please see our [contributing](CONTRIBUTING.md) documentation for further instructions.

## Support

We are always here to help!

Please see our [support](SUPPORT.md) documentation for further instructions.

## Copyright and License

```
Copyright 2024 Target Brands, Inc.
```

[Apache License, Version 2.0](../LICENSE)
25 changes: 25 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Support

Welcome to Vela! To get help with a specific aspect of Vela, we've provided the below information.

## Bugs or Feature Requests

We use GitHub for tracking bugs and feature requests.

Please see our [contributing](CONTRIBUTING.md) documentation for further instructions.

## Installation and Usage

We use GitHub pages for hosting our installation and usage documentation.

Please see our [documentation](https://go-vela.github.io/docs) site for more information.

## Local Development

Please see our [local development documentation](DOCS.md) for more information.

## Questions

We use Slack for supporting questions not already covered in the above documents.

Please join the [#vela](https://gophers.slack.com/app_redirect?channel=CNRRKE8KY) channel.
6 changes: 6 additions & 0 deletions .github/renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"local>go-vela/renovate-config"
]
}
51 changes: 51 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Publish Site

on:
push:
branches: [main]
workflow_dispatch:

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build:
runs-on: linux-standard
env:
base_path: "/actions-management/actions-docs"
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
with:
node-version: 22
cache: "pnpm"
cache-dependency-path: pnpm-lock.yaml

- uses: pnpm/action-setup@v2
name: Install pnpm
with:
version: 9
run_install: true

- name: Build
run: pnpm build

- name: Upload artifact
uses: actions/upload-pages-artifact@a753861a5debcf57bf8b404356158c8e1e33150c # v2
with:
path: ./build

publish:
needs: build
runs-on: linux-standard
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@13b55b33dd8996121833dbc1db458c793a334630 # v3
26 changes: 26 additions & 0 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Test deployment

on:
pull_request:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
test-deploy:
name: Test deployment
runs-on: linux-standard
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 22
cache: pnpm

- name: Install dependencies
run: pnpm install
- name: Test build website
run: pnpm build
20 changes: 20 additions & 0 deletions .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*
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
registry="https://registry.npmjs.org/"
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v21.5.0
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

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

### Installation

```
$ yarn
```

### Local Development

```
$ yarn 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

```
$ yarn build
```

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

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn 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.
Binary file added blog/10919.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions blog/2024-12-04-first-blog-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
slug: first-blog-post
title: Welcome to the Vela Prototype
authors: [vader, sanders]
tags: [cicd, vela]
---

Welcome to the Vela (VEE-la) docsite! This page covers the core components of building pipelines. We will walk through the components that make up a pipeline and show how/where they are used inside a Vela YAML file (Can be .vela.yml or .vela.yaml) at the base of a GitHub repository.

<!-- truncate -->

Vela has a few core pipeline types known as steps, stages, and templates. Steps pipelines should be used in situations when everything in the workflow needs to be accomplished sequentially. Stages are pipelines that are leveraged when workflows can or need to run in parallel. Lastly, templates, the goal with these pipelines is to identify one too many tasks that can be abstracted and used repeatedly. A common use case for templates is matrix builds. Accomplishing a set of tasks with slight variations between them.

All tasks in Vela pipelines execute commands inside ephemeral Docker containers. By integrating with Docker we provide isolation between steps and allow for safe execution of concurrent tasks on the same machine. Using containers also empowers users to customize the build dependencies or automation utilities they want Vela to perform within their pipeline.

A plugin is a Docker container that performs a pre-defined set of tasks and typically is configured as a step in pipelines. Plugins can be used to deploy code, publish artifacts, send notifications, and much more. Additionally, for even more powerful workflows you can string together a set of plugins into a single template to create reusable pipelines across your applications. Users can create one or many templates, to be stored in separate files, and then reference each template in the full pipeline configuration.
Binary file added blog/22219.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
vader:
name: David Vader
title: Sr. Engineer
url: https://github.com/plyr4
image_url: https://avatars.githubusercontent.com/u/48764154
page: true

sanders:
name: Kell Sanders
title: Engineer
url: https://github.com/killedgier
image_url: https://avatars.githubusercontent.com/u/123609015
page: true
31 changes: 31 additions & 0 deletions blog/tags.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
facebook:
label: Facebook
permalink: /facebook
description: Facebook tag description

hello:
label: Hello
permalink: /hello
description: Hello tag description

docusaurus:
label: Docusaurus
permalink: /docusaurus
description: Docusaurus tag description

hola:
label: Hola
permalink: /hola
description: Hola tag description

cicd:
label: CICD
permalink: /cicd
description: CICD tag description

vela:
label: Vela
permalink: /vela
description: Vela tag description


12 changes: 12 additions & 0 deletions docs/installation/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"label": "Installation",
"position": 1,
"link": {
"type": "generated-index",
"description": "A Vela cluster is deployed as a self-hosted solution and consists of two core services, the server and the worker. The relationship between these services is considered many-to-many meaning many workers can connect to many servers.

The server is considered the brains of the application while the worker is considered the brawn of the application.

An optional third service, the UI, can also be deployed but is not required for the Vela platform to operate as intended. This service provides a means for utilizing and interacting with the Vela platform."
}
}
Loading

0 comments on commit 984e16d

Please sign in to comment.