[PR #40] [MERGED] Add 'usage' section with explanation of 'dump' command #39

Closed
opened 2026-02-16 11:40:07 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/go-gitea/docs/pull/40
Author: @issmirnov
Created: 12/28/2016
Status: Merged
Merged: 12/28/2016
Merged by: @lunny

Base: masterHead: master


📝 Commits (1)

  • 9ca3ee3 add 'usage' section with explanation of 'dump' command

📊 Changes

2 files changed (+62 additions, -0 deletions)

View changed files

content/doc/usage.en-us.md (+13 -0)
content/doc/usage/backup-and-restore.en-us.md (+49 -0)

📄 Description

As per go-gitea/gitea#448, sending a PR that adds a new 'Usage' section to the docs and documents the behavior of the dump command.

Please let me know what you think of the phrasing and structure.

Looking forward, it would be nice to have explanations of all the commands added to these docs. Right now this information is only present in the CLI help:

     web      Start Gitea web server
     serv     This command should only be called by SSH shell
     update   This command should only be called by Git hook
     dump     Dump Gitea files and database
     cert     Generate self-signed certificate
     admin    Preform admin operations on command line
     help, h  Shows a list of commands or help for one command

IMO, web cert and admin would be the most useful.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/go-gitea/docs/pull/40 **Author:** [@issmirnov](https://github.com/issmirnov) **Created:** 12/28/2016 **Status:** ✅ Merged **Merged:** 12/28/2016 **Merged by:** [@lunny](https://github.com/lunny) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (1) - [`9ca3ee3`](https://github.com/go-gitea/docs/commit/9ca3ee35393c2c6022d93ac1c32780f594b600e2) add 'usage' section with explanation of 'dump' command ### 📊 Changes **2 files changed** (+62 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `content/doc/usage.en-us.md` (+13 -0) ➕ `content/doc/usage/backup-and-restore.en-us.md` (+49 -0) </details> ### 📄 Description As per go-gitea/gitea#448, sending a PR that adds a new 'Usage' section to the docs and documents the behavior of the `dump` command. Please let me know what you think of the phrasing and structure. Looking forward, it would be nice to have explanations of all the commands added to these docs. Right now this information is only present in the CLI help: ``` web Start Gitea web server serv This command should only be called by SSH shell update This command should only be called by Git hook dump Dump Gitea files and database cert Generate self-signed certificate admin Preform admin operations on command line help, h Shows a list of commands or help for one command ``` IMO, `web` `cert` and `admin` would be the most useful. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-16 11:40:07 -05:00
yindo closed this issue 2026-02-16 11:40:07 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: go-gitea/docs#39