1
0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-11-24 08:02:18 +02:00
woodpecker/docs
6543 7fb9191cce
Update Documentation (fix diffs and add settings) (#569)
* Add migration guide for plugin settings

* Update screenshot snippets

* Adjust plugin settings

* Fix diff insertion

Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2021-12-06 18:18:53 +01:00
..
docs Update Documentation (fix diffs and add settings) (#569) 2021-12-06 18:18:53 +01:00
plugins/woodpecker-plugins Update docs dependencies (#553) 2021-11-27 15:13:00 +01:00
src Improve docs (#450) 2021-10-16 21:27:51 +02:00
static [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
.gitignore [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
.prettierrc.js Improve docs (#450) 2021-10-16 21:27:51 +02:00
babel.config.js [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
docusaurus.config.js Update README (#560) 2021-12-03 15:36:22 +01:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json Update docs dependencies (#553) 2021-11-27 15:13:00 +01:00
README.md Update links to woodpecker-ci.org (#445) 2021-10-14 18:13:57 +02:00
sidebars.js [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
tsconfig.json Improve docs (#450) 2021-10-16 21:27:51 +02:00
yarn.lock Update docs dependencies (#553) 2021-11-27 15:13:00 +01:00

Website

This website is built using Docusaurus 2, 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

Deployment happen via CI to woodpecker-ci.org.

To manually build the website and push it exec:

GIT_USER=woodpecker-bot USE_SSH=true DEPLOYMENT_BRANCH=master yarn deploy