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

docs: update the ROOT documentation and error messages #19832

Merged
merged 5 commits into from
May 30, 2022

Conversation

singuliere
Copy link
Contributor

  • The documentation now reflects what happens in the
    setting/repository.go::newRepository function:
    filepath.Join(AppWorkPath, RepoRootPath) was missing.

  • The error message displayed when RepoRootPath is not found now
    displays the value of RepoRootPath. Given the complexity of the
    construction of this value, only referring to it in the abstract
    is likely to be misleading to the Gitea admin trying to interpret
    the message.

* The documentation now reflects what happens in the
  setting/repository.go::newRepository function:
  filepath.Join(AppWorkPath, RepoRootPath) was missing.

* The error message displayed when RepoRootPath is not found now
  displays the value of RepoRootPath. Given the complexity of the
  construction of this value, only referring to it in the abstract
  is likely to be misleading to the Gitea admin trying to interpret
  the message.
@singuliere singuliere added the type/docs This PR mainly updates/creates documentation label May 28, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #19832 (176edd5) into main (65e0688) will increase coverage by 0.00%.
The diff coverage is 0.00%.

@@           Coverage Diff           @@
##             main   #19832   +/-   ##
=======================================
  Coverage   47.28%   47.29%           
=======================================
  Files         957      957           
  Lines      133346   133346           
=======================================
+ Hits        63055    63066   +11     
+ Misses      62628    62619    -9     
+ Partials     7663     7661    -2     
Impacted Files Coverage Δ
cmd/serv.go 2.33% <0.00%> (ø)
modules/queue/queue_bytefifo.go 47.29% <0.00%> (-2.89%) ⬇️
modules/queue/workerpool.go 53.62% <0.00%> (-1.04%) ⬇️
routers/api/v1/repo/pull.go 47.17% <0.00%> (+0.17%) ⬆️
models/issue_comment.go 52.23% <0.00%> (+0.33%) ⬆️
models/repo_list.go 83.37% <0.00%> (+0.44%) ⬆️
routers/web/repo/view.go 40.48% <0.00%> (+0.48%) ⬆️
services/pull/check.go 29.13% <0.00%> (+1.18%) ⬆️
modules/queue/queue_disk_channel.go 62.08% <0.00%> (+1.25%) ⬆️
models/unit/unit.go 48.71% <0.00%> (+1.70%) ⬆️
... and 1 more

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 65e0688...176edd5. Read the comment docs.

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label May 28, 2022
docs/content/doc/advanced/config-cheat-sheet.en-us.md Outdated Show resolved Hide resolved
docs/content/doc/advanced/config-cheat-sheet.en-us.md Outdated Show resolved Hide resolved
cmd/serv.go Show resolved Hide resolved
docs/content/doc/help/faq.en-us.md Outdated Show resolved Hide resolved
cmd/serv.go Show resolved Hide resolved
singuliere and others added 3 commits May 30, 2022 07:30
Co-authored-by: delvh <dev.lh@web.de>
@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 May 30, 2022
@6543 6543 added this to the 1.17.0 milestone May 30, 2022
@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 May 30, 2022
@6543 6543 merged commit fdc784d into go-gitea:main May 30, 2022
zjjhot added a commit to zjjhot/gitea that referenced this pull request Jun 1, 2022
* giteaofficial/main:
  Fix spelling mistake in ProcReceive (go-gitea#19853)
  Ensure responses are context.ResponseWriters (go-gitea#19843)
  Fix inconsistency in doctor output (go-gitea#19836)
  docs: recommendations to ensure backup consistency and reliability (go-gitea#19845)
  feat: Add support for extra sshd_config parameters via 'Include' file (go-gitea#19842)
  [skip ci] Updated translations via Crowdin
  docs: update the ROOT documentation and error messages (go-gitea#19832)
AbdulrhmnGhanem pushed a commit to kitspace/gitea that referenced this pull request Aug 24, 2022
* docs: update the ROOT documentation and error messages

* The documentation now reflects what happens in the
  setting/repository.go::newRepository function:
  filepath.Join(AppWorkPath, RepoRootPath) was missing.

* The error message displayed when RepoRootPath is not found now
  displays the value of RepoRootPath. Given the complexity of the
  construction of this value, only referring to it in the abstract
  is likely to be misleading to the Gitea admin trying to interpret
  the message.

Co-authored-by: delvh <dev.lh@web.de>
@go-gitea go-gitea locked and limited conversation to collaborators May 3, 2023
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.

7 participants