aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/doc/developers/api-usage.en-us.md
Commit message (Collapse)AuthorAgeFilesLines
* Restructure documentation. Now the documentation has installation, ↵Lunny Xiao2023-03-231-137/+0
| | | | | | | | | | | | | | | | | | | | | | administration, usage, development, contributing the 5 main parts (#23629) - **Installation**: includes how to install Gitea and related other tools, also includes upgrade Gitea - **Administration**: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - **Usage**: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - **Development**: includes how to integrate with Gitea's API, how to develop new features within Gitea - **Contributing**: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com>
* Remove insecure flag from curl (#21074)John Olheiser2022-09-051-1/+1
| | | | | | | | Followup to #21071 Thanks for the catch @wxiaoguang [WRT](https://github.com/go-gitea/gitea/pull/21071#discussion_r962706673) Ref #21071
* Update curl usage in API docs (#21071)John Olheiser2022-09-051-4/+4
|
* Add documentation about pagination of the API (#20740)techknowlogick2022-08-091-0/+12
| | | | | | | | | * Add documentation about pagination of the API * Update docs/content/doc/developers/api-usage.en-us.md Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Add markdownlint (#20512)silverwind2022-07-281-1/+0
| | | | Add `markdownlint` linter and fix issues. Config is based on the one from electron's repo with a few rules relaxed.
* Fix various typos of software names (#18083)qwerty2872021-12-241-2/+2
| | | | | | | | | | | | | | | | * `git` -> `Git` * `Github` and `github` -> `GitHub` * `crowdin` -> `Crowdin` * `git-lfs` -> `Git LFS` * `githooks`, `git hooks`, `git-hooks` -> `Git Hooks` * `discord` -> `Discord` * `2fa` -> `2FA` * `gitlab` and `Gitlab` -> `GitLab` * `web hook` -> `webhook` * `linux` -> `Linux` * `sqlite` -> `SQLite` * `MYSQL` and `mysql` -> `MySQL` * rename refs to `master` branch -> `main` * Fix English grammar
* Rework Token API comments (#15162)Ian Wienand2021-05-161-22/+36
| | | | | | | Move the token API discussion into a common section discussing the generation and listing of the tokens. Add a note on the display of the sha1 during creation and listing. Co-authored-by: Norwin <noerw@users.noreply.github.com>
* Added OpenAPI document link to usage (#15535)Nathan Zook2021-04-191-0/+3
| | | | | | | | | | | | | | * Added OpenAPI document link to usage The OpenAPI document at /api/swagger.v1.json needs an obvious reference. Sadly, I am English monolingual, so someone else is going to have to do the other languages. In the mean time, this PR should help anyone looking for the file. * Update docs/content/doc/developers/api-usage.en-us.md Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: techknowlogick <matti@mdranta.net> Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Reformat docs (#13897)Patrick Schratz2020-12-091-13/+14
| | | | Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lauris BH <lauris@nix.lv>
* Added Table of Contents to long documentation pages (#13890)65432020-12-071-3/+5
| | | | | | | | * Redo #13836 with new shortcode (https://gitea.com/gitea/theme/pulls/90) * add Api Usage Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Refactor docs (#13275)John Olheiser2020-10-231-0/+106
* First pass Signed-off-by: jolheiser <john.olheiser@gmail.com> * More changes Signed-off-by: jolheiser <john.olheiser@gmail.com> * Redirects Signed-off-by: jolheiser <john.olheiser@gmail.com>