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

Refactor docs #13275

Merged
merged 5 commits into from
Oct 23, 2020
Merged

Refactor docs #13275

merged 5 commits into from
Oct 23, 2020

Conversation

jolheiser
Copy link
Member

This PR refactors the docs and moves some things from advanced to a new developers sections, as some of them may be more appropriate for someone looking to integrate rather than an end-user.

It also removes the CI/CD and Third-party pages in lieu of an Integrations page that directs users to awesome-gitea with some examples of what they will find.

Signed-off-by: jolheiser <john.olheiser@gmail.com>
Signed-off-by: jolheiser <john.olheiser@gmail.com>
@jolheiser jolheiser added the type/docs This PR mainly updates/creates documentation label Oct 23, 2020
@jolheiser jolheiser added this to the 1.14.0 milestone Oct 23, 2020
@techknowlogick
Copy link
Member

Thanks for giving some love to the docs. Improving the docs is always appreciated. Could you also add some redirects from the deleted pages to the new location, here is the redirect file: https://github.com/go-gitea/gitea/blob/d84490a0df308f0783637e39bf5302128f9f8584/docs/static/_redirects and here are docs from netlify on the redirect format: https://docs.netlify.com/routing/redirects/#syntax-for-the-netlify-configuration-file

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Oct 23, 2020
@codecov-io
Copy link

Codecov Report

Merging #13275 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #13275      +/-   ##
==========================================
+ Coverage   42.15%   42.17%   +0.01%     
==========================================
  Files         684      684              
  Lines       75536    75536              
==========================================
+ Hits        31843    31857      +14     
+ Misses      38468    38457      -11     
+ Partials     5225     5222       -3     
Impacted Files Coverage Δ
modules/util/timer.go 42.85% <0.00%> (-42.86%) ⬇️
routers/repo/view.go 37.47% <0.00%> (-0.65%) ⬇️
modules/git/repo.go 46.70% <0.00%> (+0.50%) ⬆️
services/pull/patch.go 55.68% <0.00%> (+1.70%) ⬆️
services/pull/temp_repo.go 29.78% <0.00%> (+3.19%) ⬆️
modules/git/utils.go 77.04% <0.00%> (+3.27%) ⬆️
services/pull/check.go 52.55% <0.00%> (+3.64%) ⬆️
modules/charset/charset.go 73.03% <0.00%> (+4.49%) ⬆️
modules/indexer/stats/db.go 60.86% <0.00%> (+8.69%) ⬆️

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 9912a11...6c00e07. Read the comment docs.

@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 Oct 23, 2020
Signed-off-by: jolheiser <john.olheiser@gmail.com>
@jolheiser
Copy link
Member Author

@techknowlogick I think I got it right? I'm not sure if I can test it locally, but afaik that should be correct. Not sure if there's a better way with the en-us part, but I don't think I changed the other languages (other than api-usage because it was just a dir change).

@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 Oct 23, 2020
@techknowlogick
Copy link
Member

technically you can test locally (using the netlify cli tool), but this LGTM and will test once merged (If we were using Github integration w/ netlify then it have a URL for each URL, but Drone works better for our workflow and will allow us to switch to gitea.com with less issues)

@techknowlogick
Copy link
Member

🚀

@techknowlogick techknowlogick merged commit 1d6b565 into go-gitea:master Oct 23, 2020
@techknowlogick techknowlogick added the skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. label Oct 23, 2020
@jolheiser jolheiser deleted the cleanup-docs branch October 23, 2020 16:00
@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. skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants