Commit Graph

31 Commits

Author SHA1 Message Date
6543
5a7b689e30 Switch to go vanity urls (#2706)
Co-authored-by: Anbraten <anton@ju60.de>
2023-11-07 08:04:33 +01:00
qwerty287
8946d2099c Update docusaurus to v3 (#2732)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: pat-s <patrick.schratz@gmail.com>
2023-11-05 10:43:44 +01:00
Patrick Schratz
856b2ef8c7 pre-commit fixes (#2669)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Anbraten <anton@ju60.de>
2023-10-31 09:14:09 +01:00
Anbraten
66a5ba4e4f Add prettier (#2600) 2023-10-24 14:42:05 +02:00
qwerty287
d1c51f4af8 Lazy-load TimeAgo locales (#2094)
1. new translation docs
2. lazy-load TimeAgo locales (used for "x min ago" messages). This 1.
reduces size and 2. provides all languages without adding them manually.
3. Remove DayJS locales, they're unused.
2023-08-03 19:25:12 +02:00
Anbraten
e0ed1b3e49 Change master to main (#2044) 2023-07-31 05:47:23 +02:00
qwerty287
5c587a3243 Add security section to docs (#1877) 2023-06-21 16:59:57 +02:00
runephilosof-karnovgroup
e3593cd9a4 01-getting-started.md: fix WOODPECKER_HOST example (#1849) 2023-06-12 23:22:00 +02:00
Martin W. Kirst
14177635b6 Update swagger API specification (#1782)
# Summary

This PR drops the outdated former swagger.yaml/json and introduced
automatic API document generation from Go code.
The generated code is also used to generate documentation/markdown for
the community page,
as well as enable the Woodpecker server to serve a Swagger Web UI for
manual tinkering.

I did opt-in for gin-swagger, a middleware for the Gin framework, to
ease implementation and have a sophisticated output.
This middleware only produces Swagger v2 specs. AFAIK the newer OpenApi
3x tooling is not yet that mature,
so I guess that's fine for now.

## Implemenation notes

- former swagger.json files removed
- former // swagger godocs removed
- introduced new dependency gin-swagger, which uses godoc annotations on
top of Gin Handler functions.
- reworked Makefile to automatically generate Go code for the server
- introduce new dependency go-swagger, to generate Markdown for
documentation purposes
- add a Swagger Web UI, incl. capabilities for manual API exploration
- consider relative root paths in the implementation
- write documentation for all exposed API endpoints
- incl. API docs in the community website (auto-generated)
- provide developer documentation, for the Woodpecker authors
- no other existing logic/code was intentionally changed

---------

close #292

---------

Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
Co-authored-by: 6543 <6543@obermui.de>
2023-06-03 21:38:36 +02:00
6543
317bd24abb Define Glossary (#1800)
based on
https://github.com/woodpecker-ci/woodpecker/issues/745#issuecomment-1313401427

close  #1724

---------

Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
Co-authored-by: Anbraten <anton@ju60.de>
2023-06-03 16:39:56 +02:00
6543
a1943aa49e Buildin Env Vars, use _URL for all links/urls (#1794)
based on https://framadate.org/jVSQHwIGfJYy82IL

close #1793
2023-05-31 18:03:38 +02:00
Dhanu Saputra
e9fc5ebd0e 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>
2023-03-24 18:18:14 +01:00
Lauris BH
46452fbd84 Update Go dependencies and minimal Go version to 1.20 (#1650)
Signed-off-by: 6543 <6543@obermui.de>
Co-authored-by: 6543 <6543@obermui.de>
2023-03-21 00:48:15 +01:00
6543
f71142d162 Pin official default clone image (#1526)
address https://github.com/woodpecker-ci/woodpecker/issues/1508#issuecomment-1368007494
2023-01-10 17:34:21 +01:00
smainz
73067c5868 Add a sentence regarding translations to the development docs (UI page) (#1459)
Make obvious, that at least an English message key has to be added to the message files
2022-12-21 14:45:41 +01:00
Josh Soref
023d03dd61 Spelling (#1405)
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2022-11-09 08:12:17 +01:00
qwerty287
3372d1a87c Rename remote to forge (#1357)
As of #745

Co-authored-by: Anbraten <anton@ju60.de>
2022-11-05 00:35:06 +01:00
Harikesh00
36e42914fa Renamed procs/jobs to steps in code (#1331)
Renamed `procs` to `steps` in code for the issue #1288

Co-authored-by: Harikesh Prajapati <harikesh.prajapati@druva.com>
Co-authored-by: qwerty287 <ndev@web.de>
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
Co-authored-by: 6543 <6543@obermui.de>
2022-10-28 17:38:53 +02:00
Yarden Shoham
4dbf3c671b Fix typos in docs (#1273)
Did used [cspell](https://www.npmjs.com/package/cspell) to find typos and fixed it.

Also add cspell to gitpod.

Signed-off-by: Yarden Shoham <hrsi88@gmail.com>
2022-10-15 20:25:55 +02:00
Lukas
fd6923fe20 Replace yarn with pnpm (#1240)
Should resolve startup issues in gitpod and be a lot faster 🚀
2022-10-08 16:15:07 +02:00
Anbraten
605a048b58 Use versioned docs (#1145) 2022-09-01 01:52:52 +02:00
Anbraten
5557674835 Add gitpod setup (#1020)
Adding [Gitpod](https://github.com/gitpod-io/gitpod) allows us and others to easily start a complete Woodpecker setup and development cloud IDE. It starts a Woodpecker server, agent and a preconfigured Gitea instance. You can login at Gitea with `woodpecker` and `password`.
2022-07-31 17:07:18 +02:00
Lauris BH
99f1b70570 Add option to launch all needed services for local development (#988)
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
2022-06-17 16:24:49 +02:00
6543
08479390ff Use editorconfig-checker (#982) 2022-06-17 12:03:34 +02:00
6543
0ab5182402 Document package architecture (#972)
to make it easier for devs to find the right place for code

close #655

Co-authored-by: Anbraten <anton@ju60.de>
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
2022-06-16 15:35:58 +02:00
qwerty287
7d7d75d7e5 Support localized web UI (#912)
* Add support for localization
* Add docs & format code
* Add lib to docs
2022-05-16 21:18:48 +02:00
Anbraten
ee97977b93 Update and cleanup docs (#851)
- migrate step conditions back into pipeline syntax, but show 2-4 level in toc to be able to see `when` keywords
- create new backend section in admin docs
- update docusaurus
- remove prefix docker of container / container-image where possible
- replace terms SCM, VCS, Github with [forge](https://en.wikipedia.org/wiki/Forge_(software))
- add darkmode favicon variant
2022-04-06 17:15:28 +02:00
Johan Van de Wauw
8fa2a5efe4 Fix various typos (#835) 2022-03-09 01:44:08 +01:00
6543
c186e2fa8c Update dev-docs & improve migration code (#670) 2022-01-08 20:21:22 +01:00
Anbraten
bed69f9f72 Improve dev docs (#636) 2021-12-21 10:52:10 +01:00
Anbraten
465d2c9d84 Add development docs (#610)
Add documentation on how to develop woodpecker

Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Lukas <lukas@slucky.de>
2021-12-21 04:45:41 +01:00