Skip to content

update documentation #23571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 23 additions & 24 deletions docs/content/page/index.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,21 @@ draft: false
# What is Gitea?

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/)
Gitea is a fork of repository named [Gogs](http://gogs.io). Kindly check out the [Gitea Announcement](https://blog.gitea.io/2016/12/welcome-to-gitea/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While it's also true that the Gitea repo is a fork of the Gogs repo, the previous statement makes more sense imo, that the Gitea project is a fork of the Gogs project, or "Gitea is a fork of Gogs".

I do like the change to the next sentence, though. 🙂

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ohkk....thank you for considering 😀

blog post to read about the justification for a fork.

## Purpose

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 platform-independently across
**all platforms** which Go supports, including Linux, macOS, and Windows,
This is possible with Go, it is platform-independent and supports **all platforms**, including Linux, macOS, and Windows,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is different from the previous statement. Gitea should work on all platforms that Go supports, but Go doesn't support "all" platforms.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed. Go for example does not support Solaris 😉

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed. Go for example does not support Solaris 😉

It should support Solaris on amd64 arch.
https://go.dev/doc/install/source#environment

Copy link
Member

@silverwind silverwind Mar 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean Solaris on SPARC 😆

on x86, amd64, ARM and PowerPC architectures.
You can try it out using [the online demo](https://try.gitea.io/).

## Features

- User Dashboard
> <b>User Dashboard</b>
- Context switcher (organization or current user)
- Activity timeline
- Commits
Expand All @@ -36,7 +35,7 @@ You can try it out using [the online demo](https://try.gitea.io/).
- Searchable repository list
- List of organizations
- A list of mirror repositories
- Issues dashboard
> <b>Issues dashboard</b>
- Context switcher (organization or current user)
- Filter by
- Open
Expand All @@ -49,28 +48,28 @@ You can try it out using [the online demo](https://try.gitea.io/).
- Oldest
- Last updated
- Number of comments
- Pull request dashboard
> <b>Pull request dashboard</b>
- Same as issue dashboard
- Repository types
> <b>Repository types</b>
- Mirror
- Normal
- Migrated
- Notifications (email and web)
> <b>Notifications (email and web)</b>
- Read
- Unread
- Pin
- Explore page
> <b>Explore page</b>
- Users
- Repos
- Organizations
- Search
- Custom templates
- Override public files (logo, css, etc)
- CSRF and XSS protection
- HTTPS support
- Set allowed upload sizes and types
- Logging
- Configuration
> <b>Custom templates</b>
> <b>Override public files (logo, css, etc)</b>
> <b>CSRF and XSS protection</b>
> <b>HTTPS support</b>
> <b>Set allowed upload sizes and types</b>
> <b>Logging</b>
> <b>Configuration</b>
- Databases
- MySQL (>=5.7)
- PostgreSQL (>=10)
Expand Down Expand Up @@ -130,16 +129,16 @@ You can try it out using [the online demo](https://try.gitea.io/).
- Clean up old archives
- Environment variables
- Command line options
- Multi-language support ([21 languages](https://github.com/go-gitea/gitea/tree/main/options/locale))
- [Mermaid](https://mermaidjs.github.io/) diagrams in Markdown
- Math syntax in Markdown
- Mail service
- <b>Multi-language support ([21 languages](https://github.com/go-gitea/gitea/tree/main/options/locale))</b>
- <b>[Mermaid](https://mermaidjs.github.io/) diagrams in Markdown</b>
- <b>Math syntax in Markdown</b>
- <b>Mail service</b>
- Notifications
- Registration confirmation
- Password reset
- Reverse proxy support
> <b>Reverse proxy support</b>
- Includes subpaths
- Users
> <b>Users</b>
- Profile
- Name
- Username
Expand All @@ -165,7 +164,7 @@ You can try it out using [the online demo](https://try.gitea.io/).
- Two factor authentication
- Linked OAuth2 sources
- Delete account
- Repositories
> <b>Repositories</b>
- Clone with SSH/HTTP/HTTPS
- Git LFS
- Watch, Star, Fork
Expand Down Expand Up @@ -253,7 +252,7 @@ You can try it out using [the online demo](https://try.gitea.io/).
- Webhooks
- Git Hooks
- Deploy keys
- Package Registries
> <b>Package Registries</b>
- Composer
- Conan
- Container
Expand Down