aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoe Chen <jc@unknwon.io>2021-12-18 11:23:59 +0800
committerGitHub <noreply@github.com>2021-12-18 11:23:59 +0800
commit160a0b77cfb73907cd6ad127823d6daffdff8251 (patch)
treeb4fd465b6a3fab1d564ea236ff7cf2d4547dfc19 /docs
parent6528bf35dc2cb93c10165bc890073839a8ecd944 (diff)
docs: update links and outdated conent (#6680)
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/local_development.md8
-rw-r--r--docs/dev/release/issue_template_minor_version.md6
-rw-r--r--docs/dev/release/issue_template_patch_release.md6
3 files changed, 9 insertions, 11 deletions
diff --git a/docs/dev/local_development.md b/docs/dev/local_development.md
index 07756f04..7d1265e5 100644
--- a/docs/dev/local_development.md
+++ b/docs/dev/local_development.md
@@ -1,7 +1,5 @@
# Getting started with developing Gogs
-> This document is driven from https://docs.sourcegraph.com/dev/local_development.
-
Gogs is written in [Go](https://golang.org/), please take [A Tour of Go](https://tour.golang.org/) if you haven't done so!
## Outline
@@ -23,7 +21,7 @@ Gogs is built and runs as a single binary and meant to be cross platform. Theref
Gogs has the following dependencies:
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) (v1.8.3 or higher)
-- [Go](https://golang.org/doc/install) (v1.14 or higher)
+- [Go](https://golang.org/doc/install) (v1.15 or higher)
- [Less.js](http://lesscss.org/usage/#command-line-usage-installing)
- [Task](https://github.com/go-task/task)
- Database upon your choice (pick one, we choose PostgreSQL in this document):
@@ -123,7 +121,7 @@ Generally, you don't need a full clone, so set `--depth` to `10`:
git clone --depth 10 https://github.com/gogs/gogs.git
```
-**NOTE** The repository has Go Modules enabled, please clone to somewhere outside of your `$GOPATH`.
+**NOTE** The repository has Go modules enabled, please clone to somewhere outside of your `$GOPATH`.
## Step 4: Configure database settings
@@ -162,7 +160,7 @@ LOAD_ASSETS_FROM_DISK = true
### Offline development
-Sometimes you will want to develop Gogs but it just so happens you will be on a plane or a train or perhaps a beach, and you will have no WiFi. And you may raise your fist toward heaven and say something like, "Why, we can put a man on the moon, so why can't we develop high-quality Git hosting without an Internet connection?" But lower your hand back to your keyboard and fret no further, for the year is 2020, and you *can* develop Gogs with no connectivity by setting the following configuration in your `custom/conf/app.ini`:
+Sometimes you will want to develop Gogs but it just so happens you will be on a plane or a train or perhaps a beach, and you will have no WiFi. And you may raise your fist toward heaven and say something like, "Why, we can put a man on the moon, so why can't we develop high-quality Git hosting without an Internet connection?" But lower your hand back to your keyboard and fret no further, you *can* develop Gogs with no connectivity by setting the following configuration in your `custom/conf/app.ini`:
```ini
[server]
diff --git a/docs/dev/release/issue_template_minor_version.md b/docs/dev/release/issue_template_minor_version.md
index c360d65b..111db41a 100644
--- a/docs/dev/release/issue_template_minor_version.md
+++ b/docs/dev/release/issue_template_minor_version.md
@@ -13,10 +13,10 @@ On release branch:
- [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/main/gogs.go#L21) to the current release, e.g. `0.12.0+dev` -> `0.12.0`.
- [ ] Publish a new [GitHub release](https://github.com/gogs/gogs/releases) with entries from [CHANGELOG](https://github.com/gogs/gogs/blob/main/CHANGELOG.md) for the current release.
-- [ ] Wait for a new [Docker Hub tag](https://hub.docker.com/r/gogs/gogs/tags) for the current release to be created automatically.
+- [ ] Wait for a new image tag for the current release to be created automatically on both [Docker Hub](https://hub.docker.com/r/gogs/gogs/tags) and [GitHub Container registry](https://github.com/gogs/gogs/pkgs/container/gogs).
- [ ] Push another Docker image tag as `<MAJOR>.<MINOR>`, e.g. `0.12`.
- [ ] Compile and pack binaries (all prefixed with `gogs_<MAJOR>.<MINOR>.<PATCH>_`, e.g. `gogs_0.12.0_`):
- - [ ] macOS: `darwin_amd64.zip`
+ - [ ] macOS: `darwin_amd64.zip`, `darwin_arm64.zip`
- [ ] Linux: `linux_386.tar.gz`, `linux_386.zip`, `linux_amd64.tar.gz`, `linux_amd64.zip`
- [ ] ARM: `linux_armv7.tar.gz`, `linux_armv7.zip`
- [ ] Windows: `windows_amd64.zip`, `windows_amd64_mws.zip`
@@ -31,7 +31,7 @@ On release branch:
On develop branch:
- [ ] Update the repository mirror on [Gitee](https://gitee.com/unknwon/gogs).
-- [ ] Create a new release topic on [Gogs Discussion](https://discuss.gogs.io/c/announcements/5).
+- [ ] Create a new release announcement in [Discussions](https://github.com/gogs/gogs/discussions/categories/announcements).
- [ ] Send out release announcement emails via [Mailchimp](https://mailchimp.com/).
- [ ] Publish a new release article on [OSChina](http://my.oschina.net/Obahua/admin/releases).
- [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/main/gogs.go#L21) to the new develop version, e.g. `0.12.0+dev` -> `0.13.0+dev`.
diff --git a/docs/dev/release/issue_template_patch_release.md b/docs/dev/release/issue_template_patch_release.md
index 60bff854..16989ffe 100644
--- a/docs/dev/release/issue_template_patch_release.md
+++ b/docs/dev/release/issue_template_patch_release.md
@@ -17,10 +17,10 @@ On release branch:
```
**ℹ️ Heads up! There is a new patch release [0.12.1](https://github.com/gogs/gogs/releases/tag/v0.12.1) available, we recommend directly installing or upgrading to that version.**
```
-- [ ] Wait for a new [Docker Hub tag](https://hub.docker.com/r/gogs/gogs/tags) for the current release to be created automatically.
+- [ ] Wait for a new image tag for the current release to be created automatically on both [Docker Hub](https://hub.docker.com/r/gogs/gogs/tags) and [GitHub Container registry](https://github.com/gogs/gogs/pkgs/container/gogs).
- [ ] Update Docker image tag for the minor release `<MAJOR>.<MINOR>`, e.g. `0.12`.
- [ ] Compile and pack binaries (all prefixed with `gogs_<MAJOR>.<MINOR>.<PATCH>_`, e.g. `gogs_0.12.0_`):
- - [ ] macOS: `darwin_amd64.zip`
+ - [ ] macOS: `darwin_amd64.zip`, `darwin_arm64.zip`
- [ ] Linux: `linux_386.tar.gz`, `linux_386.zip`, `linux_amd64.tar.gz`, `linux_amd64.zip`
- [ ] ARM: `linux_armv7.tar.gz`, `linux_armv7.zip`, `linux_armv8.tar.gz`, `linux_armv8.zip`
- [ ] Windows: `windows_amd64.zip`, `windows_amd64_mws.zip`
@@ -39,5 +39,5 @@ On develop branch:
The <MAJOR>.<MINOR>.<PATCH> has been released.
```
- [ ] Update the repository mirror on [Gitee](https://gitee.com/unknwon/gogs).
-- [ ] Reply to the release topic for the minor release on [Gogs Discussion](https://discuss.gogs.io/c/announcements/5).
+- [ ] Reply to the release topic for the minor release in [Discussions](https://github.com/gogs/gogs/discussions/categories/announcements).
- [ ] Close the patch milestone.