aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/page/index.en-us.md
diff options
context:
space:
mode:
authorMichael Lustfield <MTecknology@users.noreply.github.com>2018-01-08 16:48:42 -0600
committerKim "BKC" Carlbäcker <kim.carlbacker@gmail.com>2018-01-08 23:48:42 +0100
commit3ee8be384982260586454546c2b272daeceb1944 (patch)
tree9f13eb3ee6df7f427ba626776da8be4cccc28574 /docs/content/page/index.en-us.md
parent923c0105f4fab51d1b9510ba432200dc619bb94e (diff)
downloadgitea-3ee8be384982260586454546c2b272daeceb1944.tar.gz
gitea-3ee8be384982260586454546c2b272daeceb1944.zip
General documentation cleanup (#3317)
* Clean up spelling, grammar, perspective, whitespace, language, markup, etc.
Diffstat (limited to 'docs/content/page/index.en-us.md')
-rw-r--r--docs/content/page/index.en-us.md23
1 files changed, 14 insertions, 9 deletions
diff --git a/docs/content/page/index.en-us.md b/docs/content/page/index.en-us.md
index 9592830a3b..0f22fcfe58 100644
--- a/docs/content/page/index.en-us.md
+++ b/docs/content/page/index.en-us.md
@@ -9,11 +9,16 @@ draft: false
# What is Gitea?
-Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket or Gitlab. The initial development have been done on [Gogs](http://gogs.io) but we have forked it and named it Gitea. If you want to read more about the reasons why we have done that please read [this](https://blog.gitea.io/2016/12/welcome-to-gitea/) blog post.
+Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket, and Gitlab.
+Gitea is a fork of [Gogs](http://gogs.io). See the [Gitea Announcement](https://blog.gitea.io/2016/12/welcome-to-gitea/)
+blog post to read about the justification for a fork.
## Purpose
-The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. With Go, this can be done with an independent binary distribution across ALL platforms that Go supports, including Linux, macOS and Windows, even on architectures like ARM or PowerPC.
+The goal of this project is to provide the easiest, fastest, and most painless way of setting
+up a self-hosted Git service. With Go, this can be done with an independent binary distribution
+across all platforms and architectures that Go supports. This support includes Linux, macOS, and
+Windows, on architectures like amd64, i386, ARM, PowerPC, and others.
## Features
@@ -25,7 +30,7 @@ The goal of this project is to make the easiest, fastest, and most painless way
- Pull requests
- Repository creation
- Searchable repository list
- - List of your organizations
+ - List of organizations
- A list of mirror repositories
- Issues dashboard
- Context switcher (organization or current user)
@@ -67,9 +72,9 @@ The goal of this project is to make the easiest, fastest, and most painless way
- PostgreSQL
- SQLite3
- MSSQL
- - [TiDB](https://github.com/pingcap/tidb) (experimental)
+ - TiDB (experimental, not recommended)
- Configuration file
- - See [here](https://github.com/go-gitea/gitea/blob/master/conf/app.ini)
+ - [app.ini](https://github.com/go-gitea/gitea/blob/master/conf/app.ini)
- Admin panel
- Statistics
- Actions
@@ -245,14 +250,14 @@ The goal of this project is to make the easiest, fastest, and most painless way
## System Requirements
-- A cheap Raspberry Pi is powerful enough for basic functionality.
-- 2 CPU cores and 1GB RAM would be the baseline for teamwork.
-- Gitea is supposed to be run with a dedicated non-root user account on UNIX systems, no other mode of operation is supported. (**NOTE**: in case you run it with your own user account and the built-in SSH server disabled, Gitea modifies the `~/.ssh/authorized_keys` file so you will **not** be able to interactively log in.)
+- A Raspberry Pi 3 is powerful enough to run Gitea for small workloads.
+- 2 CPU cores and 1GB RAM is typically sufficient for small teams/projects.
+- Gitea should be run with a dedicated non-root system account on UNIX-type systems.
+ - Note: Gitea manages the `~/.ssh/authorized_keys` file. Running gitea as a regular user could break that user's ability to log in.
## Browser Support
- Please see [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) for specific versions of supported browsers.
-- The official support minimal size is **1024*768**, UI may still looks right in smaller size but no promises and fixes.
## Components