Skip to content
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

[Docs] Add guide on howto develop API #9587

Merged
merged 12 commits into from Jan 4, 2020
Merged

[Docs] Add guide on howto develop API #9587

merged 12 commits into from Jan 4, 2020

Conversation

6543
Copy link
Member

@6543 6543 commented Jan 2, 2020

  • should be same as github api if same endpoint ..
  • document locations where to change things
  • wat shoud be optional
    ... suggestions?

@codecov-io
Copy link

codecov-io commented Jan 2, 2020 •
edited

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #9587      +/-   ##
==========================================
+ Coverage   42.14%   42.15%   +<.01%     
==========================================
  Files         578      578              
  Lines       76015    76015              
==========================================
+ Hits        32034    32041       +7     
+ Misses      40006    40000       -6     
+ Partials     3975     3974       -1
Impacted Files Coverage Δ
models/unit.go 62.16% <0%> (-5.41%) ⬇️
modules/log/event.go 65.64% <0%> (+1.02%) ⬆️
services/pull/check.go 53.52% <0%> (+4.92%) ⬆️

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 bedd7b2...138d32d. Read the comment docs.

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jan 2, 2020
@6543 6543 marked this pull request as ready for review January 2, 2020 15:04
@lunny lunny added the type/docs This PR mainly updates/creates documentation label Jan 3, 2020
bagasme
bagasme reviewed Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
bagasme
bagasme reviewed Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
bagasme
bagasme reviewed Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
bagasme
bagasme reviewed Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
bagasme
bagasme suggested changes Jan 3, 2020
View reviewed changes
Copy link
Contributor

@bagasme bagasme left a comment

Choose a reason for hiding this comment

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

I think I commented 4 times with grammar suggestions. Please apply or clarify them.

davidsvantesson
davidsvantesson reviewed Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@6543
Copy link
Member Author

6543 commented Jan 3, 2020

thanks for all suggestions - I was hoping somebody has better formulations ...

@techknowlogick techknowlogick changed the title [Docs] Add Guid howto develop API [Docs] Add guide on howto develop API Jan 3, 2020
bagasme
bagasme reviewed Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@6543
Copy link
Member Author

6543 commented Jan 3, 2020 •
edited

@davidsvantesson-> 4f787bb
PS: deepL helped me this time ;)

@6543
Copy link
Member Author

6543 commented Jan 3, 2020 •
edited

@techknowlogick i think it is ready?

@jolheiser
Copy link
Member

I'll look more later today, but at a quick glance all example links need to be permalinks, otherwise the line numbers are at risk to change.

6543
6543 commented Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
6543
6543 commented Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
6543
6543 commented Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
jolheiser
jolheiser requested changes Jan 3, 2020
View reviewed changes
Copy link
Member

@jolheiser jolheiser left a comment

Choose a reason for hiding this comment

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

Some thoughts and nits.
Thanks for adding this! APIs can be daunting for contributors, so having a guideline will be much appreciated I'm sure!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
6543
6543 commented Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
6543
6543 commented Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@6543 @jolheiser
Apply suggestions from code review
ddce1a9 
Co-Authored-By: John Olheiser <42128690+jolheiser@users.noreply.github.com>
jolheiser
jolheiser reviewed Jan 3, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@6543 @jolheiser
Apply suggestions from code review
333ed37 
Co-Authored-By: John Olheiser <42128690+jolheiser@users.noreply.github.com>
@jolheiser
Copy link
Member

Aha, didn't even notice until I checked the rendered document, but can you also add this section to the ToC at the top of the page?

@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 Jan 3, 2020
@6543
Copy link
Member Author

6543 commented Jan 3, 2020

@jolheiser done :D

@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 Jan 3, 2020
@6543
Copy link
Member Author

6543 commented Jan 3, 2020

🎉

@6543
Copy link
Member Author

6543 commented Jan 3, 2020

@techknowlogick ready to merge 🚀

@6543
Copy link
Member Author

6543 commented Jan 3, 2020

@lafriks could you add this to 1.11.0 ?

@lafriks
Copy link
Member

lafriks commented Jan 3, 2020

docs does not really need milestone if they are not version specific

@6543
Copy link
Member Author

6543 commented Jan 3, 2020

ok

@lunny lunny merged commit ee9b936 into go-gitea:master Jan 4, 2020
@6543 6543 deleted the docu-api-contribution-guid branch January 4, 2020 02:23
@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

@bagasme bagasme bagasme requested changes

@davidsvantesson davidsvantesson davidsvantesson approved these changes

@jolheiser jolheiser jolheiser approved these changes

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.

None yet
9 participants
@6543 @codecov-io @jolheiser @lafriks @davidsvantesson @techknowlogick @bagasme @lunny @GiteaBot