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

Fix some incorrect links in docs #28191

Merged
merged 2 commits into from
Nov 24, 2023
Merged

Fix some incorrect links in docs #28191

merged 2 commits into from
Nov 24, 2023

Conversation

yp05327
Copy link
Contributor

@yp05327 yp05327 commented Nov 24, 2023

https://gitea.com/gitea/gitea-docusaurus/actions/runs/661/jobs/0#jobstep-9-39
I noticed that there are many warning logs in building docs.
It is causing 404 in docs.gitea.com now, so we need to fix it.
And there are also some other problems in v1.19 which can not be done in this PR.

ps: Are there any good methods to test this in local?

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Nov 24, 2023
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 24, 2023
@yp05327 yp05327 mentioned this pull request Nov 24, 2023
Merged
techknowlogick pushed a commit that referenced this pull request Nov 24, 2023
@yp05327
Remove misadded packages docs in 1.19 (#28192)
ac70ffc 
Follow #28191

There are some misadded docs in #24914's backport PR #25016.
The following package registries are all supported in 1.20, so we should
not have docs in v1.19

- Alpine (#23714)
- CRAN  (#22343)
- Debain (#24426)
- Go (#24687)
- RPM (#23380)
@techknowlogick techknowlogick added the skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. label Nov 24, 2023
@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 Nov 24, 2023
@lunny lunny added the type/docs This PR mainly updates/creates documentation label Nov 24, 2023
lng2020
lng2020 reviewed Nov 24, 2023
View reviewed changes
docs/content/usage/actions/act-runner.en-us.md
@@ -114,7 +114,7 @@ If you cannot see the settings page, please make sure that you have the right pe

The format of the registration token is a random string `D0gvfu2iHfUjNqCYVljVyRV14fISpJxxxxxxxxxx`.

A registration token can also be obtained from the gitea [command-line interface](../../administration/command-line.en-us.md#actions-generate-runner-token):
Copy link
Member

Choose a reason for hiding this comment

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

Seems unnecessary prefix. Just adminstration/xxx is okay.

Copy link
Contributor Author

@yp05327 yp05327 Nov 27, 2023 •
edited

Choose a reason for hiding this comment

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

image
You are right. It seems that ../../ is incorrect

ps: Maybe I know how to test it in local now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

↑ The log above is incorrect because of the bug in make prepare-doc command.
See: https://gitea.com/gitea/gitea-docusaurus/pulls/92

But maybe it is better to let them in a same format.

docs/content/administration/email-setup.zh-cn.md
@@ -55,7 +55,7 @@ PASSWD = `password`

要发送测试邮件以验证设置，请转到 Gitea > 站点管理 > 配置 > SMTP 邮件配置。

有关所有选项的完整列表，请查看[配置速查表](doc/administration/config-cheat-sheet.zh-cn.md)。
Copy link
Member

Choose a reason for hiding this comment

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

.

docs/content/usage/actions/act-runner.zh-cn.md
@@ -113,7 +113,7 @@ Runner级别决定了从哪里获取注册令牌。

注册令牌的格式是一个随机字符串 `D0gvfu2iHfUjNqCYVljVyRV14fISpJxxxxxxxxxx`。

注册令牌也可以通过 Gitea 的 [命令行](../../administration/command-line.en-us.md#actions-generate-runner-token) 获得:
Copy link
Member

Choose a reason for hiding this comment

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

.

@lng2020
Copy link
Member

lng2020 commented Nov 24, 2023 •
edited

Some of them should be backported to v1.21 and v1.20. I guess it's no harm to add backport labels since the merge will conflict.

@lng2020 lng2020 added backport/v1.20 This PR should be backported to Gitea 1.20 backport/v1.21 This PR should be backported to Gitea 1.21 labels Nov 24, 2023
@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 Nov 24, 2023
@lunny lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Nov 24, 2023
@lunny lunny enabled auto-merge (squash) November 24, 2023 13:54
@GiteaBot
Copy link
Contributor

@yp05327 please fix the merge conflicts. 🍵

@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Nov 24, 2023
@lunny lunny merged commit ad9aac3 into go-gitea:main Nov 24, 2023
24 checks passed
@GiteaBot GiteaBot added this to the 1.22.0 milestone Nov 24, 2023
@GiteaBot
Copy link
Contributor

I was unable to create a backport for 1.20. @yp05327, please send one manually. 🍵

go run ./contrib/backport 28191
...  // fix git conflicts if any
go run ./contrib/backport --continue

@GiteaBot GiteaBot added the backport/manual No power to the bots! Create your backport yourself! label Nov 24, 2023
@GiteaBot GiteaBot mentioned this pull request Nov 24, 2023
Merged
GiteaBot pushed a commit to GiteaBot/gitea that referenced this pull request Nov 24, 2023
@yp05327 @GiteaBot
Fix some incorrect links in docs (go-gitea#28191)
8a3b859 
https://gitea.com/gitea/gitea-docusaurus/actions/runs/661/jobs/0#jobstep-9-39
I noticed that there are many warning logs in building docs.
It is causing 404 in docs.gitea.com now, so we need to fix it.
And there are also some other problems in v1.19 which can not be done in
this PR.

ps: Are there any good methods to test this in local?
techknowlogick pushed a commit that referenced this pull request Nov 24, 2023
@GiteaBot @yp05327
Fix some incorrect links in docs (#28191) (#28201)
4b89c0f 
Backport #28191 by @yp05327


https://gitea.com/gitea/gitea-docusaurus/actions/runs/661/jobs/0#jobstep-9-39
I noticed that there are many warning logs in building docs.
It is causing 404 in docs.gitea.com now, so we need to fix it.
And there are also some other problems in v1.19 which can not be done in
this PR.

Co-authored-by: yp05327 <576951401@qq.com>
@yp05327 yp05327 deleted the fix-incorrect-link-in-doc branch November 26, 2023 23:40
This was referenced Nov 26, 2023
Merged
Merged
Merged
zjjhot added a commit to zjjhot/gitea that referenced this pull request Nov 27, 2023
@zjjhot
Merge remote-tracking branch 'giteaofficial/main'
b5c792f 
* giteaofficial/main:
  Fix actions when tagging (go-gitea#28061)
  Fix comment permissions (go-gitea#28213)
  Docs: Replace deprecated IS_TLS_ENABLED mailer setting in email setup (go-gitea#28205)
  Fix delete-orphaned-repos (go-gitea#28200)
  Refactor graceful manager to use shared code (go-gitea#28073)
  Fix some incorrect links in docs (go-gitea#28191)
  Remove workaround in disk-clean.yml (go-gitea#28195)
techknowlogick pushed a commit that referenced this pull request Nov 27, 2023
@yp05327
Fix links in docs (#28234)
0a0e820 
Follow #28191

Changes:
- `(doc/administration/config-cheat-sheet.md` is incorrect:

![image](https://github.com/go-gitea/gitea/assets/18380374/1c417dd7-61a0-49ba-8d50-871fd4c9bf20)
- remove `../../`
@GiteaBot GiteaBot mentioned this pull request Nov 27, 2023
Merged
GiteaBot pushed a commit to GiteaBot/gitea that referenced this pull request Nov 27, 2023
@yp05327 @GiteaBot
Fix links in docs (go-gitea#28234)
f48560e 
Follow go-gitea#28191

Changes:
- `(doc/administration/config-cheat-sheet.md` is incorrect:

![image](https://github.com/go-gitea/gitea/assets/18380374/1c417dd7-61a0-49ba-8d50-871fd4c9bf20)
- remove `../../`
techknowlogick pushed a commit that referenced this pull request Nov 27, 2023
@yp05327
Fix docs problems in 1.19 (#28236)
3d7f636 
Follow #28191
lunny pushed a commit that referenced this pull request Nov 27, 2023
@GiteaBot @yp05327
Fix links in docs (#28234) (#28238)
ca5f0c9 
Backport #28234 by @yp05327

Follow #28191

Changes:
- `(doc/administration/config-cheat-sheet.md` is incorrect:

![image](https://github.com/go-gitea/gitea/assets/18380374/1c417dd7-61a0-49ba-8d50-871fd4c9bf20)
- remove `../../`

Co-authored-by: yp05327 <576951401@qq.com>
techknowlogick pushed a commit that referenced this pull request Nov 27, 2023
@yp05327
Fix some incorrect links in docs (#28191) (#28233)
088d746 
Backport #28191
fuxiaohei pushed a commit to fuxiaohei/gitea that referenced this pull request Jan 17, 2024
@yp05327 @fuxiaohei
Fix some incorrect links in docs (go-gitea#28191)
329a7d5 
https://gitea.com/gitea/gitea-docusaurus/actions/runs/661/jobs/0#jobstep-9-39
I noticed that there are many warning logs in building docs.
It is causing 404 in docs.gitea.com now, so we need to fix it.
And there are also some other problems in v1.19 which can not be done in
this PR.

ps: Are there any good methods to test this in local?
fuxiaohei pushed a commit to fuxiaohei/gitea that referenced this pull request Jan 17, 2024
@yp05327 @fuxiaohei
Fix links in docs (go-gitea#28234)
853a9a7 
Follow go-gitea#28191

Changes:
- `(doc/administration/config-cheat-sheet.md` is incorrect:

![image](https://github.com/go-gitea/gitea/assets/18380374/1c417dd7-61a0-49ba-8d50-871fd4c9bf20)
- remove `../../`
silverwind pushed a commit to silverwind/gitea that referenced this pull request Feb 20, 2024
@yp05327 @silverwind
Fix some incorrect links in docs (go-gitea#28191)
56d82ef 
https://gitea.com/gitea/gitea-docusaurus/actions/runs/661/jobs/0#jobstep-9-39
I noticed that there are many warning logs in building docs.
It is causing 404 in docs.gitea.com now, so we need to fix it.
And there are also some other problems in v1.19 which can not be done in
this PR.

ps: Are there any good methods to test this in local?
silverwind pushed a commit to silverwind/gitea that referenced this pull request Feb 20, 2024
@yp05327 @silverwind
Fix links in docs (go-gitea#28234)
e431206 
Follow go-gitea#28191

Changes:
- `(doc/administration/config-cheat-sheet.md` is incorrect:

![image](https://github.com/go-gitea/gitea/assets/18380374/1c417dd7-61a0-49ba-8d50-871fd4c9bf20)
- remove `../../`
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Feb 22, 2024
@lunny lunny added the backport/done All backports for this PR have been created label Feb 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@lng2020 lng2020 lng2020 left review comments

@lunny lunny lunny approved these changes

@delvh delvh delvh approved these changes

Assignees
No one assigned
Labels
backport/done All backports for this PR have been created backport/manual No power to the bots! Create your backport yourself! backport/v1.20 This PR should be backported to Gitea 1.20 backport/v1.21 This PR should be backported to Gitea 1.21 lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/docs size/S Denotes a PR that changes 10-29 lines, ignoring generated files. 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
Milestone
1.22.0
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@yp05327 @lng2020 @GiteaBot @lunny @delvh @techknowlogick