diff --git a/docs/docs/10-intro.md b/docs/docs/10-intro.md index 9b5edb502..90d644d27 100644 --- a/docs/docs/10-intro.md +++ b/docs/docs/10-intro.md @@ -86,3 +86,8 @@ pipeline: ``` See [plugin docs](./20-usage/51-plugins/10-plugins.md). + +## Continue reading + +- [Create a Woodpecker pipeline for your repository](./20-usage/10-intro.md) +- [Setup your own Woodpecker instance](./30-administration/00-setup.md) diff --git a/docs/docs/30-administration/00-setup.md b/docs/docs/30-administration/00-setup.md index 191e1cb85..71a26b501 100644 --- a/docs/docs/30-administration/00-setup.md +++ b/docs/docs/30-administration/00-setup.md @@ -11,6 +11,12 @@ A Woodpecker deployment consists of two parts: > > You can add more agents to increase the number of parallel steps or set the agent's `WOODPECKER_MAX_WORKFLOWS=1` environment variable to increase the number of parallel workflows for that agent. +## Which version of Woodpecker should I use? + +Woodpecker is having two different kinds of releases: **stable** and **next**. + +To find out more about the differences between the two releases, please read the [FAQ](/faq). + ## Installation You can install Woodpecker on multiple ways: diff --git a/docs/docs/80-downloads.md b/docs/docs/80-downloads.md index 5630c27ae..1201f25ce 100644 --- a/docs/docs/80-downloads.md +++ b/docs/docs/80-downloads.md @@ -1,5 +1,11 @@ # Downloads +## Which version of Woodpecker should I use? + +Woodpecker is having two different kinds of releases: **stable** and **next**. + +To find out more about the differences between the two releases, please read the [FAQ](/faq). + ## Binaries & DEB, RPM [Latest release](https://github.com/woodpecker-ci/woodpecker/releases/latest) diff --git a/docs/docs/91-migrations.md b/docs/docs/91-migrations.md index f7df03af7..88f92fa9e 100644 --- a/docs/docs/91-migrations.md +++ b/docs/docs/91-migrations.md @@ -2,7 +2,7 @@ Some versions need some changes to the server configuration or the pipeline configuration files. -## 1.0.0 +## 1.0.0 (next) - The signature used to verify extensions calls (like those used for the [config-extension](./30-administration/100-external-configuration-api.md)) done by the Woodpecker server switched from using a shared-secret HMac to an ed25519 key-pair. Read more about it at the [config-extensions](./30-administration/100-external-configuration-api.md) documentation. - Refactored support of old agent filter labels and expression. Learn how to use the new [filter](./20-usage/20-pipeline-syntax.md#labels) diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 511124a44..794877fdc 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -26,7 +26,7 @@ module.exports = { items: [ { type: 'doc', - docId: 'usage/intro', + docId: 'intro', activeBaseRegex: 'docs/(?!migrations|awesome)', position: 'left', label: 'Docs', @@ -76,6 +76,10 @@ module.exports = { { title: 'Docs', items: [ + { + label: 'Introduction', + to: '/docs/intro', + }, { label: 'Usage', to: '/docs/usage/intro', diff --git a/docs/src/pages/faq.md b/docs/src/pages/faq.md index 0a20455fd..ea341bbb8 100644 --- a/docs/src/pages/faq.md +++ b/docs/src/pages/faq.md @@ -11,6 +11,18 @@ Apart from Woodpecker staying free and OpenSource forever, the growing community The Drone CI license was changed after the 0.8 release from Apache 2 to a proprietary license. Woodpecker is based on this latest freely available version. +## Which version of Woodpecker should I use? + +Woodpecker is having two different kinds of releases: **stable** and **next**. + +The **stable** releases (currently version 0.15) is a long-term supported (LTS) stable version. The stable releases are only getting bugfixes. + +The **next** release contains all bugfixes and features from `master`. Normally it should be pretty stable, but as its frequently updated, it might contain some bugs from time to time. + +If you want all (new) features of Woodpecker and are willing to accept some possible bugs from time to time, you should use the next release otherwise use the stable release. + +You can find download links for the different releases in the [download section](/docs/downloads). + ## How to debug clone issues: (And what to do with an error message like `fatal: could not read Username for 'https://': No such device or address`) @@ -45,7 +57,7 @@ pipeline: Get the container id using `docker ps` and copy the id from the first column. Enter the container with: `docker exec -it 1234asdf bash` (replace `1234asdf` with the docker id). Then try to clone the git repository with the commands from the failing pipeline: ```bash $ git init -$ git remote add origin https://git.example.com/username/repo.git -$ git fetch --no-tags origin +refs/heads/branch: +$ git remote add origin https://git.example.com/username/repo.git +$ git fetch --no-tags origin +refs/heads/branch: ``` (replace the url AND the branch with the correct values, use your username and password as log in values) diff --git a/docs/versioned_docs/version-0.15/10-intro.md b/docs/versioned_docs/version-0.15/10-intro.md index 694223534..9f0d68efb 100644 --- a/docs/versioned_docs/version-0.15/10-intro.md +++ b/docs/versioned_docs/version-0.15/10-intro.md @@ -27,7 +27,7 @@ pipeline: - Define any Docker image as context - either use your own and install the needed tools in custom Docker images, or - - search [Docker Hub](https://hub.docker.com/search?type=image) for images that are already tailored for your needs) + - search [Docker Hub](https://hub.docker.com/search?type=image) for images that are already tailored for your needs) - List the commands that should be executed in your container, in order to build or test your application ```diff @@ -85,3 +85,8 @@ pipeline: ``` See [plugin docs](./20-usage/51-plugins/10-plugins.md). + +## Continue reading + +- [Create a Woodpecker pipeline for your repository](./20-usage/10-intro.md) +- [Setup your own Woodpecker instance](./30-administration/00-setup.md) diff --git a/docs/versioned_docs/version-0.15/30-administration/00-setup.md b/docs/versioned_docs/version-0.15/30-administration/00-setup.md index 08e045d97..f00fa7a97 100644 --- a/docs/versioned_docs/version-0.15/30-administration/00-setup.md +++ b/docs/versioned_docs/version-0.15/30-administration/00-setup.md @@ -10,6 +10,12 @@ A Woodpecker deployment consists of two parts: > > You can add more agents to increase the number of parallel builds or set the agent's `WOODPECKER_MAX_PROCS=1` environment variable to increase the number of parallel builds for that agent. +## Which version of Woodpecker should I use? + +Woodpecker is having two different kinds of releases: **stable** and **next**. + +To find out more about the differences between the two releases, please read the [FAQ](/faq). + ## Installation You can install Woodpecker on multiple ways: diff --git a/docs/versioned_docs/version-0.15/80-downloads.md b/docs/versioned_docs/version-0.15/80-downloads.md index f97455778..4c22844a5 100644 --- a/docs/versioned_docs/version-0.15/80-downloads.md +++ b/docs/versioned_docs/version-0.15/80-downloads.md @@ -1,5 +1,11 @@ # Downloads +## Which version of Woodpecker should I use? + +Woodpecker is having two different kinds of releases: **stable** and **next**. + +To find out more about the differences between the two releases, please read the [FAQ](/faq). + ## Binaries & DEB, RPM [Latest release](https://github.com/woodpecker-ci/woodpecker/releases/latest)