Skip to content

Copyedit docs #6275

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 23 commits into from
Mar 9, 2019
Merged

Copyedit docs #6275

merged 23 commits into from
Mar 9, 2019

Conversation

veeara282
Copy link
Contributor

I made a few copyedits to the documentation, including several large changes (e.g. Github → GitHub).

techknowlogick
techknowlogick reviewed Mar 8, 2019
View reviewed changes
@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Mar 8, 2019
techknowlogick
techknowlogick reviewed Mar 8, 2019
View reviewed changes
@techknowlogick
Copy link
Member

Thanks for PR 😄, other than the two small nits, this looks great!

@veeara282
Copy link
Contributor Author

veeara282 commented Mar 8, 2019 •
edited
Loading

Should there be a comma after each dependent clause, as in: "Before you enable HTTPS[,] make sure that you have valid SSL/TLS certificates."? There are a lot of sentences like this without the comma and a few with it.

@lafriks
Copy link
Member

lafriks commented Mar 8, 2019

Please undo also changes in vendor directory

@codecov-io
Copy link

codecov-io commented Mar 8, 2019 •
edited
Loading

Codecov Report

Merging #6275 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6275      +/-   ##
==========================================
- Coverage   38.88%   38.87%   -0.01%     
==========================================
  Files         359      359              
  Lines       51018    51018              
==========================================
- Hits        19836    19834       -2     
- Misses      28312    28314       +2     
  Partials     2870     2870
Impacted Files Coverage Δ
routers/api/v1/repo/pull.go 17.7% <ø> (ø) ⬆️
models/issue_assignees.go 40.86% <ø> (ø) ⬆️
models/action.go 60.98% <ø> (ø) ⬆️
routers/api/v1/repo/issue.go 23.46% <ø> (ø) ⬆️
models/repo_list.go 66.84% <0%> (-1.06%) ⬇️

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 8fffb06...f60331e. Read the comment docs.

@techknowlogick techknowlogick added the type/docs This PR mainly updates/creates documentation label Mar 8, 2019
@techknowlogick
Copy link
Member

@aidan-fitz In terms of your question re: commas. I have no preference either way as long as it is consistent.

techknowlogick and others added 3 commits March 8, 2019 15:29
@techknowlogick
Link to oauth PR in comparison
cb98895
@veeara282
Add commas after dependent clauses
f756d86 
Also fix comma splices

Signed-off-by: Aidan Fitzgerald <acf67@cornell.edu>
@veeara282
Condense wording on issue/PR template page
abba8a9 
Signed-off-by: Aidan Fitzgerald <acf67@cornell.edu>
@zeripath
Copy link
Contributor

zeripath commented Mar 8, 2019

There's still a few locale file changes in here. You should remove them.

@veeara282
Copy link
Contributor Author

On the webhooks page, are these headings case-sensitive?

X-Github-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473
X-Github-Event: push

@zeripath
Copy link
Contributor

zeripath commented Mar 8, 2019

If you Google them you'll see that GitHub actually intends them to be X-GitHub- so they should change too

@veeara282
Capitalize "X-GitHub-*" headers
a02ecf4 
Signed-off-by: Aidan Fitzgerald <acf67@cornell.edu>
adelowo
adelowo reviewed Mar 8, 2019
View reviewed changes
adelowo
adelowo reviewed Mar 8, 2019
View reviewed changes
@veeara282
install -> installation (noun form)
da0866a 
Signed-off-by: Aidan Fitzgerald <acf67@cornell.edu>
zeripath
zeripath suggested changes Mar 9, 2019
View reviewed changes
Copy link
Contributor

@zeripath zeripath left a comment

Choose a reason for hiding this comment

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

One more nit. I have just been bitten by the gofmt change - so we change that.

@veeara282
Go 1.11 -> 1.12
8bc9545 
Signed-off-by: Aidan Fitzgerald <acf67@cornell.edu>
@veeara282
Copy link
Contributor Author

@zeripath Is there anything in particular we should change?

@GiteaBot GiteaBot 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 Mar 9, 2019
adelowo
adelowo reviewed Mar 9, 2019
View reviewed changes
adelowo and others added 2 commits March 9, 2019 14:49
@adelowo
Update docs/content/doc/usage/https-support.md
a671f52 
Add "the"

Co-Authored-By: aidan-fitz <aidan-fitz@users.noreply.github.com>
@veeara282
apiKey -> API key
f60331e 
Signed-off-by: Aidan Fitzgerald <acf67@cornell.edu>
@GiteaBot GiteaBot 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 Mar 9, 2019
@techknowlogick techknowlogick merged commit f5cf9a8 into go-gitea:master Mar 9, 2019
@veeara282 veeara282 deleted the copyedit-docs branch March 9, 2019 22:03
@go-gitea go-gitea locked and limited conversation to collaborators Nov 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@techknowlogick techknowlogick techknowlogick left review comments

+2 more reviewers

@zeripath zeripath zeripath approved these changes

@adelowo adelowo adelowo approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. type/docs This PR mainly updates/creates documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@veeara282 @techknowlogick @lafriks @codecov-io @zeripath @adelowo @GiteaBot