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.

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

Update and expand information about building Gitea #6019

Merged
merged 16 commits into from
Feb 12, 2019

Conversation

zeripath
Copy link
Contributor

@zeripath zeripath commented Feb 9, 2019

The current information on gitea.io for building and hacking on is inadequate. This PR expands on this and provides some more information.

Signed-off-by: Andrew Thornton art27@cantab.net

@zeripath zeripath added the type/docs This PR mainly updates/creates documentation label Feb 9, 2019
@zeripath zeripath added this to the 1.8.0 milestone Feb 9, 2019
Signed-off-by: Andrew Thornton <art27@cantab.net>
Signed-off-by: Andrew Thornton <art27@cantab.net>
Signed-off-by: Andrew Thornton <art27@cantab.net>
@codecov-io
Copy link

codecov-io commented Feb 9, 2019

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6019      +/-   ##
==========================================
- Coverage   38.87%   38.86%   -0.01%     
==========================================
  Files         345      345              
  Lines       49491    49491              
==========================================
- Hits        19239    19237       -2     
- Misses      27471    27473       +2     
  Partials     2781     2781
Impacted Files Coverage Δ
models/repo_list.go 63.29% <0%> (-1.27%) ⬇️

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 2a03e96...0587022. Read the comment docs.

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Feb 9, 2019
Copy link
Member

@kolaente kolaente left a comment

Choose a reason for hiding this comment

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

Looks good so far, some small nits though.

Could you also add a note about adding new config options to the docs? (mainly where to put them)

Signed-off-by: Andrew Thornton <art27@cantab.net>
@zeripath
Copy link
Contributor Author

zeripath commented Feb 9, 2019

I've made some changes to hacking:

I've added information about adding settings. (Albeit perhaps a little cursory as I note that @lunny has a current PR open to refactor modules/setting/setting.go )

I've added a note to say you will need make (I thought I had put that in already. oops)

I've put a bit more detail in about swagger and go-swagger.

@zeripath
Copy link
Contributor Author

Adjusted the clarifying note about automatic build dependencies.

I have avoided mentioning vendor so far because I expect that could be quite complex. We would likely need to talk about dep ensure, make test-vendor and gopkg.toml.

There is in general a lack of documentation about hacking on the UI too. This could be done as another pr.

@sapk
Copy link
Member

sapk commented Feb 10, 2019

Vendoring and GOPATH will also change when we migrate to go mod

@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 Feb 10, 2019
Copy link
Member

@techknowlogick techknowlogick left a comment

Choose a reason for hiding this comment

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

Thanks for updating the docs!! 🎊

A few nits, but otherwise looks fantastic!

docs/content/doc/advanced/hacking-on-gitea.en-us.md Outdated Show resolved Hide resolved
docs/content/doc/installation/from-source.en-us.md Outdated Show resolved Hide resolved
@GiteaBot GiteaBot removed the lgtm/need 1 This PR needs approval from one additional maintainer to be merged. label Feb 12, 2019
@GiteaBot GiteaBot added the lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. label Feb 12, 2019
@zeripath
Copy link
Contributor Author

I just noticed that we'd added postcss so added a little thing about that. I think it's probably ready to merge now.

@zeripath zeripath merged commit 7f38e2d into go-gitea:master Feb 12, 2019
@zeripath
Copy link
Contributor Author

Thanks peeps. Hopefully people will find this helpful. I guess we just need to try to keep it up to date.

I'll pop a comment on @typeless go module pr to suggest that a bit of information to hacking and install is put down.

@zeripath zeripath deleted the update-dev-docs branch February 12, 2019 16:24
@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.
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
Development

Successfully merging this pull request may close these issues.

8 participants