Docs: make sure shell examples can be copied (#1670)

close #1656

---------

Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
This commit is contained in:
Dhanu Saputra 2023-03-25 00:18:14 +07:00 committed by GitHub
parent 3a5e912a6e
commit e9fc5ebd0e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 29 additions and 27 deletions

View file

@ -4,22 +4,22 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
### Installation ### Installation
``` ```bash
$ pnpm install pnpm install
``` ```
### Local Development ### Local Development
``` ```bash
$ pnpm start pnpm 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. 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 ### Build
``` ```bash
$ pnpm build pnpm build
``` ```
This command generates static content into the `build` directory and can be served using any static contents hosting service. This command generates static content into the `build` directory and can be served using any static contents hosting service.

View file

@ -133,13 +133,14 @@ Or you can open the test-file inside [VS-Code](#developing-with-vs-code) and run
If you want to run a Woodpecker applications from your terminal you can use one of the following commands from the base of the Woodpecker project. They will execute Woodpecker in a similar way as described in [debugging Woodpecker](#debugging-woodpecker) without the ability to really debug it in your editor. If you want to run a Woodpecker applications from your terminal you can use one of the following commands from the base of the Woodpecker project. They will execute Woodpecker in a similar way as described in [debugging Woodpecker](#debugging-woodpecker) without the ability to really debug it in your editor.
```bash ```bash title="start server"
# start server go run ./cmd/server
$ go run ./cmd/server ```
# start agent ```bash title="start agent"
$ go run ./cmd/agent go run ./cmd/agent
```
# execute cli command
$ go run ./cmd/cli [command] ```bash title="execute cli command"
go run ./cmd/cli [command]
``` ```

View file

@ -57,8 +57,8 @@ 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: 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 ```bash
$ git init git init
$ git remote add origin https://git.example.com/username/repo.git git remote add origin https://git.example.com/username/repo.git
$ git fetch --no-tags origin +refs/heads/branch: 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) (replace the url AND the branch with the correct values, use your username and password as log in values)

View file

@ -115,13 +115,14 @@ Or you can open the test-file inside [VS-Code](#developing-with-vs-code) and run
If you want to run a Woodpecker applications from your terminal you can use one of the following commands from the base of the Woodpecker project. They will execute Woodpecker in a similar way as described in [debugging Woodpecker](#debugging-woodpecker) without the ability to really debug it in your editor. If you want to run a Woodpecker applications from your terminal you can use one of the following commands from the base of the Woodpecker project. They will execute Woodpecker in a similar way as described in [debugging Woodpecker](#debugging-woodpecker) without the ability to really debug it in your editor.
```bash ```bash title="start server"
# start server go run ./cmd/server
$ go run ./cmd/server ```
# start agent ```bash title="start agent"
$ go run ./cmd/agent go run ./cmd/agent
```
# execute cli command
$ go run ./cmd/cli [command] ```bash title="execute cli command"
go run ./cmd/cli [command]
``` ```