first batch of Readme updates #65

xinity · 2016-11-04T07:00:14Z

README update WIP.

leave the PR open until all updates are committed.
comments welcome of course :)

codecov-io · 2016-11-04T07:14:36Z

Current coverage is 2.18% (diff: 100%)

Merging #65 into master will not change coverage

@@            master       #65   diff @@
========================================
  Files           31        31          
  Lines         7508      7508          
  Methods          0         0          
  Messages         0         0          
  Branches         0         0          
========================================
  Hits           164       164          
  Misses        7327      7327          
  Partials        17        17

Powered by Codecov. Last update 5a8cb2d...73d4cf6

tboerger · 2016-11-04T08:26:13Z

README.md

@@ -135,7 +138,8 @@ There are 5 ways to install Gogs:

 ## Contributors

- Ex-team members [@lunny](https://github.com/lunny), [@fuxiaohei](https://github.com/fuxiaohei) and [@slene](https://github.com/slene).
+- Owners [@lunny](https://github.com/lunny), [@tboerger](https://github.com/tboerger) and [@bkcsoft](https://github.com/bkcsoft).


I would not mention that here, we can skip the maintainance of this part. You can see that anyway on the people page of the org.

tboerger · 2016-11-04T08:27:09Z

README.md

@@ -19,7 +20,7 @@

 ### Important Notes

-1. **YOU MUST READ [Contributing Code](https://github.com/go-gitea/gitea/wiki/Contributing-Code) BEFORE STARTING TO WORK ON A PULL REQUEST**.
+1. **YOU MUST READ [Contributing Code](https://github.com/go-gitea/gitea/CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST**.


You must read the [contributors guide]() before starting to work on a pull request

tboerger · 2016-11-04T08:27:46Z

README.md


-##### Current tip version: 0.9.99 (see [Releases](https://github.com/go-gitea/gitea/releases) for binary versions or submit a task on [alpha stage automated binary building system](https://build.gogs.io/))
+##### Status
+## Current tip version: 0.9.99 (see [Releases](https://github.com/go-gitea/gitea/releases) 


This should not be a headline, beside that this branch will be 1.0.0

lunny · 2016-11-04T07:18:07Z

README.md


-##### Current tip version: 0.9.99 (see [Releases](https://github.com/go-gitea/gitea/releases) for binary versions or submit a task on [alpha stage automated binary building system](https://build.gogs.io/))
+##### Status
+## Current tip version: 0.9.99 (see [Releases](https://github.com/go-gitea/gitea/releases) 


Should a tip have a version number?

agree @lunny
i though at first to remove this line and simply link to the release page.

xinity · 2016-11-04T20:55:57Z

I've taken care of changes requested, but github stills ask for them to be taken care of.
Did i miss something ?

strk · 2016-11-05T07:45:23Z

I can see a "Dismiss review" link next to the "requested changes" record. I guess all maintainers do see that.
But given @tboerger requested the change I guess he's the one who should click that link, to confirm his request was addressed

tboerger · 2016-11-05T07:48:04Z

README.md

 2. Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) was reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site.
 3. The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
-4. If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io**. Thanks!
+4. If you think there are vulnerabilities in the project, please talk privately to **lunny@gitea.io**. Thanks!


[email protected]

tboerger · 2016-11-05T07:48:40Z

README.md


-##### Current tip version: 0.9.99 (see [Releases](https://github.com/go-gitea/gitea/releases) for binary versions or submit a task on [alpha stage automated binary building system](https://build.gogs.io/))
+##### Status
+**Current version: 1.0** (see [Releases](https://github.com/go-gitea/gitea/releases)) 


Please add a blank line here like on every headline

tboerger · 2016-11-05T07:49:01Z

README.md

@@ -71,15 +72,17 @@ The goal of this project is to make the easiest, fastest, and most painless way

 ## Installation

+**Note: As Gitea is a [gogs](https://github.com/gogits/gogs) fork, tutorials and documentation related to gogs applies to Gitea too**


strk · 2016-11-05T07:47:15Z

README.md


-##### Current tip version: 0.9.99 (see [Releases](https://github.com/go-gitea/gitea/releases) for binary versions or submit a task on [alpha stage automated binary building system](https://build.gogs.io/))
+##### Status
+**Current version: 1.0** (see [Releases](https://github.com/go-gitea/gitea/releases)) 


I think versions have 3 numbers, so would be 1.0.0 (but there's no such release made yet).
I agree on dropping this paragraph completely and just link to the releases page to figure out what the "current version" is.

strk · 2016-11-05T07:47:52Z

README.md

@@ -19,10 +20,10 @@

 ### Important Notes

-1. **YOU MUST READ [Contributing Code](https://github.com/go-gitea/gitea/wiki/Contributing-Code) BEFORE STARTING TO WORK ON A PULL REQUEST**.
+1. **YOU MUST READ THE [Contributors Code](https://github.com/go-gitea/gitea/CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST**.


@tboerger asked to use "contributors guide" here, IIRC

strk · 2016-11-05T07:48:18Z

README.md

 2. Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) was reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site.
 3. The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
-4. If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io**. Thanks!
+4. If you think there are vulnerabilities in the project, please talk privately to **lunny@gitea.io**. Thanks!


@lunny wasn't there a wider address to contact owners/maintainers ?

strk · 2016-11-05T07:49:59Z

README.md

 Make sure you install the [prerequisites](https://gogs.io/docs/installation) first.

-There are 5 ways to install Gogs:
+There are 5 ways to install Gitea:

 - [Install from binary](https://gogs.io/docs/installation/install_from_binary.html)
 - [Install from source](https://gogs.io/docs/installation/install_from_source.html)
 - [Install from packages](https://gogs.io/docs/installation/install_from_packages.html)


I would drop the gogs.io links, those would not be releases of Gitea anyway.
Maybe also drop the count of ways to install, as that number is going to change a few times before becoming stable :)

i agree but then there won't be any installation documentation links until we write one.
Doesn't matter ?

There are the other 2 ways documented in the README itself.
Besides, you cannot visit gogs.io anyway, if you are a firefox user (since about one month, due to misconfigured ssl)

codecov-io · 2016-11-08T11:38:39Z

Current coverage is 3.14% (diff: 100%)

Merging #65 into master will not change coverage

@@            master       #65   diff @@
========================================
  Files           33        33          
  Lines         7823      7823          
  Methods          0         0          
  Messages         0         0          
  Branches         0         0          
========================================
  Hits           246       246          
  Misses        7557      7557          
  Partials        20        20

Powered by Codecov. Last update f6d53ec...b5e47ad

strk · 2016-11-08T13:13:23Z

README.md

-##### Current tip version: 0.9.99 (see [Releases](https://github.com/go-gitea/gitea/releases) for binary versions or submit a task on [alpha stage automated binary building system](https://build.gogs.io/))
+##### Status
+
+**Current version: 1.0.0** (see [Releases](https://github.com/go-gitea/gitea/releases)) 


How about drop the version number (will easily get outdated) and just point to the releases page ?

done will push

strk · 2016-11-08T13:13:52Z

README.md

-6. If your team/company is using Gogs and would like to put your logo on [our website](https://gogs.io), contact us by any means.
+1. **YOU MUST READ THE [Contributors Guide](https://github.com/go-gitea/gitea/CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST**.
+4. If you think there are vulnerabilities in the project, please talk privately to **[email protected]**. Thanks!
+6. If your team/company is using Gogs and would like to put your logo on [our website](https://gitea.io), contact us by any means.


is using *Gitea ?

done will push

strk · 2016-11-08T13:14:43Z

README.md


-There are 5 ways to install Gogs:
+There are 2 ways to install Gitea:


Drop the count, those ways are going to change and we'll forget to update the count :)

done will push

strk · 2016-11-08T13:15:08Z

README.md

@@ -133,7 +123,7 @@ There are 5 ways to install Gogs:

 ## Contributors

- Ex-team members [@lunny](https://github.com/lunny), [@fuxiaohei](https://github.com/fuxiaohei) and [@slene](https://github.com/slene).
+- see [Maintainer page](https://github.com/orgs/go-gitea/people)


Capitalize See ?

not sure about this one

strk · 2016-11-08T13:15:40Z

Reviewed, feel free to ignore my review and have my LGTM :)

tboerger · 2016-11-08T14:17:52Z

README.md

-2. Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) was reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site.
-3. The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
-4. If you think there are vulnerabilities in the project, please talk privately to **[email protected]**. Thanks!
-5. If you're interested in using APIs, we have experimental support with [documentation](https://godoc.org/github.com/go-gitea/go-sdk).


I would keep that and link to the godocs.

done will push

tboerger · 2016-11-08T14:17:59Z

README.md

-5. If you're interested in using APIs, we have experimental support with [documentation](https://godoc.org/github.com/go-gitea/go-sdk).
-6. If your team/company is using Gogs and would like to put your logo on [our website](https://gogs.io), contact us by any means.
+1. **YOU MUST READ THE [Contributors Guide](https://github.com/go-gitea/gitea/CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST**.
+4. If you think there are vulnerabilities in the project, please talk privately to **[email protected]**. Thanks!


done will push

tboerger · 2016-11-08T14:18:07Z

README.md

-6. If your team/company is using Gogs and would like to put your logo on [our website](https://gogs.io), contact us by any means.
+1. **YOU MUST READ THE [Contributors Guide](https://github.com/go-gitea/gitea/CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST**.
+4. If you think there are vulnerabilities in the project, please talk privately to **[email protected]**. Thanks!
+6. If your team/company is using Gitea and would like to put your logo on [our website](https://gitea.io), contact us by any means.


I would drop that for now.

Agreed, we just became open source after all.

done will push

ghost · 2016-11-08T15:05:41Z

README.md

@@ -133,7 +123,7 @@ There are 5 ways to install Gogs:

 ## Contributors

- Ex-team members [@lunny](https://github.com/lunny), [@fuxiaohei](https://github.com/fuxiaohei) and [@slene](https://github.com/slene).
+- See [Maintainer page](https://github.com/orgs/go-gitea/people)
 - See [contributors page](https://github.com/go-gitea/gitea/graphs/contributors) for full list of contributors.


Possibly [Contributors], [Maintainer] and [Translators]?

do we have a translation team ? :)

strk · 2016-11-08T20:40:51Z

README.md

-4. If you think there are vulnerabilities in the project, please talk privately to **[email protected]**. Thanks!
-6. If your team/company is using Gitea and would like to put your logo on [our website](https://gitea.io), contact us by any means.
+2. If you think there are vulnerabilities in the project, please talk privately to **[email protected]**. Thanks!
+3. If you're interested in using APIs, we have experimental support with [documentation](https://godoc.org/github.com/go-gitea/go-sdk).


Gogs came back ?

sorry, I was wrong, all looks fine

xinity · 2016-11-09T06:41:01Z

@strk are you sure?

lunny · 2016-11-09T13:40:55Z

seems it's ready for merge. LGTM

bkcsoft · 2016-11-09T14:30:12Z

README.md

@@ -69,15 +60,14 @@ The goal of this project is to make the easiest, fastest, and most painless way

 ## Installation

-Make sure you install the [prerequisites](https://gogs.io/docs/installation) first.
+**Note: As Gitea is a [Gogs](https://github.com/gogits/gogs) fork, tutorials and documentation related to gogs applies to Gitea too**


fork of [Gogs] sounds better no?

strk · 2016-11-09T15:29:08Z

On Wed, Nov 09, 2016 at 06:30:13AM -0800, bkcsoft wrote:

fork of [Gogs] sounds better no?

Nitpicking

bkcsoft · 2016-11-09T18:26:01Z

@strk which is why I left it as a comment instead of required change 😉

strk · 2016-11-10T08:44:01Z

Do do we have your LGTM @bkcsoft ? So we can merge and move on

lunny · 2016-11-10T09:21:45Z

@tboerger we need your approval changes.

* switch gitter to discord for drone. Signed-off-by: Bo-Yi Wu <[email protected]> * add changed status Signed-off-by: Bo-Yi Wu <[email protected]>

xinity added the type/docs This PR mainly updates/creates documentation label Nov 4, 2016

xinity added this to the 1.0.0 milestone Nov 4, 2016

tboerger suggested changes Nov 4, 2016

View reviewed changes

lunny reviewed Nov 4, 2016

View reviewed changes

xinity changed the title ~~[WIP: don't merge] first batch of update~~ [WIP] first batch of update Nov 4, 2016

xinity force-pushed the feature/update_readme branch 2 times, most recently from 80747e2 to 4bff810 Compare November 4, 2016 17:38

tboerger reviewed Nov 5, 2016

View reviewed changes

strk suggested changes Nov 5, 2016

View reviewed changes

xinity force-pushed the feature/update_readme branch 2 times, most recently from 8d0b88a to 6ad5363 Compare November 5, 2016 17:24

xinity changed the title ~~[WIP] first batch of update~~ [WIP] first batch of Readme updates Nov 5, 2016

xinity added the pr/wip This PR is not ready for review label Nov 5, 2016

xinity mentioned this pull request Nov 7, 2016

Readme update #42

Closed

first batch of update [CI SKIP]

8b3bfca

xinity force-pushed the feature/update_readme branch from 6ad5363 to 8b3bfca Compare November 8, 2016 11:20

rebase

ed590dc

xinity changed the title ~~[WIP] first batch of Readme updates~~ first batch of Readme updates Nov 8, 2016

xinity removed the pr/wip This PR is not ready for review label Nov 8, 2016

strk reviewed Nov 8, 2016

View reviewed changes

readme final update

f62bb6e

tboerger suggested changes Nov 8, 2016

View reviewed changes

ghost reviewed Nov 8, 2016

View reviewed changes

strk approved these changes Nov 8, 2016

View reviewed changes

typo fix

b5e47ad

strk reviewed Nov 8, 2016

View reviewed changes

bkcsoft reviewed Nov 9, 2016

View reviewed changes

tboerger approved these changes Nov 10, 2016

View reviewed changes

strk merged commit c040f2f into go-gitea:master Nov 10, 2016

tboerger added the lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. label Nov 29, 2016

lunny pushed a commit to lunny/gitea that referenced this pull request Feb 7, 2019

switch gitter to discord for drone. (go-gitea#65)

fb22c9e

* switch gitter to discord for drone. Signed-off-by: Bo-Yi Wu <[email protected]> * add changed status Signed-off-by: Bo-Yi Wu <[email protected]>

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

		@@ -71,15 +72,17 @@ The goal of this project is to make the easiest, fastest, and most painless way

		## Installation

		Note: As Gitea is a [gogs](https://github.com/gogits/gogs) fork, tutorials and documentation related to gogs applies to Gitea too


		There are 5 ways to install Gogs:
		There are 2 ways to install Gitea:

first batch of Readme updates #65

first batch of Readme updates #65

Conversation

xinity commented Nov 4, 2016

codecov-io commented Nov 4, 2016 • edited Loading

Current coverage is 2.18% (diff: 100%)

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

xinity commented Nov 4, 2016

strk commented Nov 5, 2016

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

codecov-io commented Nov 8, 2016 • edited Loading

Current coverage is 3.14% (diff: 100%)

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 Nov 8, 2016

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

xinity commented Nov 9, 2016

lunny commented Nov 9, 2016

Choose a reason for hiding this comment

strk commented Nov 9, 2016

bkcsoft commented Nov 9, 2016

strk commented Nov 10, 2016

lunny commented Nov 10, 2016

codecov-io commented Nov 4, 2016 •

edited

Loading

codecov-io commented Nov 8, 2016 •

edited

Loading