General documentation cleanup #3317

MTecknology · 2018-01-07T00:49:07Z

This PR fixes a lot of mistakes/errors in the English version of Gitea documentation.

codecov-io · 2018-01-07T00:56:05Z

Codecov Report

Merging #3317 into master will decrease coverage by 0.18%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3317      +/-   ##
==========================================
- Coverage   35.04%   34.85%   -0.19%     
==========================================
  Files         280      280              
  Lines       40556    40556              
==========================================
- Hits        14213    14136      -77     
- Misses      24237    24331      +94     
+ Partials     2106     2089      -17

Impacted Files	Coverage Δ
modules/lfs/content_store.go	`7.81% <0%> (-35.94%)`	⬇️
modules/lfs/server.go	`20.68% <0%> (-14.33%)`	⬇️
modules/indexer/indexer.go	`70% <0%> (-7.5%)`	⬇️
models/lfs.go	`26.08% <0%> (-2.18%)`	⬇️
models/repo_indexer.go	`54.85% <0%> (+1.94%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f2b841d...c7f6181. Read the comment docs.

strk · 2018-01-07T10:26:21Z

LGTM but please rebase against master branch (rather than merging master into your branch)

thehowl · 2018-01-07T10:39:32Z

docs/content/doc/advanced/specific-variables.en-us.md

-For `GOPATH`, check [official documentation about GOPATH environment variable](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable).
-
-For others, check [official documentation about variables used when it runs the generator](https://golang.org/cmd/go/#hdr-Generate_Go_files_by_processing_source).
+For others, check [official documentation](https://golang.org/cmd/go/#hdr-Generate_Go_files_by_processing_source).


I'd suggest to change this with For documenttion about each of the variables, you can refer to the [official documentation](https://golang.org/cmd/go/#hdr-Environment_variables).

thehowl · 2018-01-07T10:46:08Z

docs/content/doc/installation/from-binary.en-us.md

+version `GLIBC\_2.14' not found (required by ./gitea)`. This is due to the integrated
+SQLite support in the binaries provided by dl.gitea.io. In this situation, it is usually
+possible to [install from source]({{< relref "from-source.en-us.md" >}}) without sqlite
+support.


Escaping the ` will not work in this case. Use the <code> tag or change the quote before GLIBC to be a '

thehowl · 2018-01-07T10:50:02Z

docs/content/doc/installation/from-binary.en-us.md


 ## Anything missing?

-Are we missing anything on this page? Then feel free to reach out to us on our [Discord server](https://discord.gg/NsatcWJ), there you will get answers to any question pretty fast.
+If anything is missing from this page, then reach out using [Discord](https://discord.gg/NsatcWJ)
+or the [IRC Channel](http://webchat.freenode.net?nick=giteachat....&channels=%23gitea&prompt=1).


... or matrix.

thehowl · 2018-01-07T10:51:13Z

docs/content/doc/installation/from-package.en-us.md


 ## Anything missing?

-Are we missing anything on this page? Then feel free to reach out to us on our [Discord server](https://discord.gg/NsatcWJ), there you will get answers to any question pretty fast.
+If anything is missing from this page, then reach out using [Discord](https://discord.gg/NsatcWJ)
+or the [IRC Channel](http://webchat.freenode.net?nick=giteachat....&channels=%23gitea&prompt=1).


... or matrix

thehowl · 2018-01-07T10:53:36Z

docs/content/doc/installation/run-as-service-in-ubuntu.en-us.md


-Change the user(git) accordingly to yours. And /home/git too if your username is different than git. Change the PORT or remove the -p flag if default port is used.  
+Change the user(git) and home)/home/git) settings to match the deployment


Did you mean (?

thehowl · 2018-01-07T10:55:37Z

docs/content/doc/installation/with-docker.en-us.md

@@ -15,13 +15,19 @@ menu:

 # Installation with Docker

-We provide automatically updated Docker images within our Docker Hub organization. It is up to you and your deployment to always use the latest stable tag or to use another service that updates the Docker image for you.
+Gitea provides automatically updated Docker images within it's Docker Hub organization. It


thehowl · 2018-01-07T10:56:07Z

docs/content/doc/installation/with-docker.en-us.md

@@ -15,13 +15,19 @@ menu:

 # Installation with Docker

-We provide automatically updated Docker images within our Docker Hub organization. It is up to you and your deployment to always use the latest stable tag or to use another service that updates the Docker image for you.
+Gitea provides automatically updated Docker images within it's Docker Hub organization. It
+possible to always use the latest stable tag or to use another service that handles updating


you mean it is possible?

thehowl · 2018-01-07T10:57:42Z

docs/content/doc/installation/with-docker.en-us.md


 # Anything missing?

-Are we missing anything on this page? Then feel free to reach out to us on our [Discord server](https://discord.gg/NsatcWJ), there you will get answers to any question pretty fast.
+If anything is missing from this page, then reach out using [Discord](https://discord.gg/NsatcWJ)
+or the [IRC Channel](http://webchat.freenode.net?nick=giteachat....&channels=%23gitea&prompt=1).


... or matrix

thehowl · 2018-01-07T10:58:55Z

docs/content/doc/upgrade/from-gogs.en-us.md

@@ -15,25 +15,28 @@ menu:

 # Upgrade from Gogs

-Gogs versions up to 0.9.146 (db schema version 15) can be smoothly upgraded to Gitea.
+Only ancient versions (up to 0.9.146) of Gogs can be easily migrated to Gitea.


Ancient sounds like they've been found near a pyramid in egypt and they are probably from a few thousand years ago. I would suggest to place Only gogs up to 0.9.146 can be...

thehowl · 2018-01-07T11:03:46Z

docs/content/page/index.en-us.md


 ## 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.
+- The officially supported minimum screen **1024x768**. It may still work on smaller sizes, but no promises or fixes.


You can probably remove this line altogether. 😉

…, etc. Includes an update about Gitea in Debian. Also fixes some render errors. Some things were probably missed, but I think this is a good start.

thehowl · 2018-01-07T16:51:45Z

docs/content/doc/advanced/specific-variables.en-us.md

-
-For others, check [official documentation about variables used when it runs the generator](https://golang.org/cmd/go/#hdr-Generate_Go_files_by_processing_source).
+For documentation about each of the variables available, refer to the
+[official documentation](https://golang.org/cmd/go/#hdr-Generate_Go_files_by_processing_source).


I did not point it out as I should, but I think referencing https://golang.org/cmd/go/#hdr-Environment_variables instead is better

lafriks · 2018-01-07T22:11:29Z

docs/content/doc/help/seek-help.en-us.md

+
+- [#gitea on Freenode](http://webchat.freenode.net?nick=giteachat....&channels=%23gitea&prompt=1)
+- [Matrix](https://matrix.to/#/#gitea-dev:matrix.org)
+- [Discord](https://discord.gg/NsatcWJ)


Please move discord up as that is our primary communication channel

It's an "unordered" list. Being concerned about what's up at top feels a lot like bikeshedding to me.
Clearly this will be a whining point, though... so I'll change it regardless.

strk · 2018-01-08T09:35:39Z

Please move discord up as that is our primary communication channel

Isn't it about time to review that decision ?

lafriks · 2018-01-08T15:24:04Z

@strk but not here in PR, it should probably be voted/discussed by maintainers other way

strk · 2018-01-08T21:04:58Z

@lafriks: your approval is pending (bike shed was repainted)

tboerger added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jan 7, 2018

lunny added the type/docs This PR mainly updates/creates documentation label Jan 7, 2018

tboerger added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jan 7, 2018

thehowl suggested changes Jan 7, 2018

View reviewed changes

MTecknology added 3 commits January 7, 2018 10:49

Clean up spelling, grammar, perspective, whitespace, language, markup…

804242e

…, etc. Includes an update about Gitea in Debian. Also fixes some render errors. Some things were probably missed, but I think this is a good start.

Fix mistakes in recent docs addition.

28798a9

minor typo

d09c6e6

thehowl reviewed Jan 7, 2018

View reviewed changes

MTecknology added 2 commits January 7, 2018 11:01

Extra clean-up; thanks thehowl!

af82789

Remove help stub, create help page, create support page.

86a50e4

thehowl approved these changes Jan 7, 2018

View reviewed changes

tboerger added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jan 7, 2018

lafriks requested changes Jan 7, 2018

View reviewed changes

Changing order to avoid the bike shed.

17c2579

Remove +x from fr docs.

b8d17a0

lafriks approved these changes Jan 8, 2018

View reviewed changes

bkcsoft added 2 commits January 8, 2018 23:19

Merge branch 'master' into master

c7f6181

Merge branch 'master' into master

13d2b4f

bkcsoft merged commit 3ee8be3 into go-gitea:master Jan 8, 2018

lunny added this to the 1.4.0 milestone Jan 9, 2018

go-gitea locked and limited conversation to collaborators Nov 23, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

General documentation cleanup #3317

General documentation cleanup #3317

MTecknology commented Jan 7, 2018

codecov-io commented Jan 7, 2018 •

edited

Loading

strk commented Jan 7, 2018

thehowl Jan 7, 2018

thehowl Jan 7, 2018

thehowl Jan 7, 2018

thehowl Jan 7, 2018

thehowl Jan 7, 2018

thehowl Jan 7, 2018

thehowl Jan 7, 2018

thehowl Jan 7, 2018

thehowl Jan 7, 2018

thehowl Jan 7, 2018

thehowl Jan 7, 2018

lafriks Jan 7, 2018

MTecknology Jan 8, 2018

strk commented Jan 8, 2018 via email

lafriks commented Jan 8, 2018

strk commented Jan 8, 2018


		Change the user(git) accordingly to yours. And /home/git too if your username is different than git. Change the PORT or remove the -p flag if default port is used.
		Change the user(git) and home)/home/git) settings to match the deployment

General documentation cleanup #3317

General documentation cleanup #3317

Conversation

MTecknology commented Jan 7, 2018

codecov-io commented Jan 7, 2018 • edited Loading

Codecov Report

strk commented Jan 7, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

strk commented Jan 8, 2018 via email

lafriks commented Jan 8, 2018

strk commented Jan 8, 2018

codecov-io commented Jan 7, 2018 •

edited

Loading