Improve docs about register/run as a service#27461
Merged
Merged
Conversation
GiteaBot
added
the
lgtm/need 2
github-actions
Bot
added
the
type/docs
lunny
approved these changes
Oct 5, 2023
GiteaBot
added
lgtm/need 1
silverwind
approved these changes
Oct 5, 2023
GiteaBot
added
lgtm/done
delvh
approved these changes
Oct 5, 2023
Member
There was a problem hiding this comment.
Interesting that we have a <h1> and <h2> with the same text…
Member
There was a problem hiding this comment.
Member
There was a problem hiding this comment.
Actually the rule is partially enabled. It does allow same heading at different levels (allow_different_nesting). If I forbid that, it finds these:
docs/content/administration/cmd-embedded.en-us.md:104 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Example"]
docs/content/administration/cmd-embedded.zh-cn.md:86 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### 示例"]
docs/content/installation/database-preparation.en-us.md:187 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### PostgreSQL"]
docs/content/installation/database-preparation.zh-cn.md:185 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### PostgreSQL"]
docs/content/installation/database-preparation.zh-cn.md:253 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### MySQL"]
Member
There was a problem hiding this comment.
In any case, I think it should be forbidden because the anchors will not work correctly.
Member
There was a problem hiding this comment.
It seems docasaurus can somewhat deal with it:
https://docs.gitea.com/administration/cmd-embedded#example
https://docs.gitea.com/administration/cmd-embedded#example-1
Issue is if the first example is deleted, the link that previously pointed to it will now point to the other example.
Member
There was a problem hiding this comment.
#27500 will fix the cases on main branch. I recommend this PR to adapt.
lunny
added
the
reviewed/wait-merge
lunny
removed
the
reviewed/wait-merge
Member
|
Duplicate MD header should be removed, #27500 will enforce this. |
Member
Author
OK. Will remove duplicate headers and wait for that PR. |
silverwind
added a commit
that referenced
this pull request
Oct 7, 2023
Duplicate headers in a single Markdown document are problemlematic because the auto-generated links won't be stable. Enable this rule with no exceptions which is also the default of `markdownlint`. For example: ```md # A ## Example # B ## Example ``` Docasaurus will generated `example` and `example-1` links for this. If the first heading is altered, the link `example` will unexpectedly move to the second example heading. Ref: #27461 (comment)
GiteaBot
pushed a commit
to GiteaBot/gitea
that referenced
this pull request
Oct 7, 2023
Duplicate headers in a single Markdown document are problemlematic because the auto-generated links won't be stable. Enable this rule with no exceptions which is also the default of `markdownlint`. For example: ```md # A ## Example # B ## Example ``` Docasaurus will generated `example` and `example-1` links for this. If the first heading is altered, the link `example` will unexpectedly move to the second example heading. Ref: go-gitea#27461 (comment)
silverwind
added a commit
that referenced
this pull request
Oct 7, 2023
Backport #27500 by @silverwind Duplicate headers in a single Markdown document are problemlematic because the auto-generated links won't be stable. Enable this rule with no exceptions which is also the default of `markdownlint`. For example: ```md # A ## Example # B ## Example ``` Docasaurus will generated `example` and `example-1` links for this. If the first heading is altered, the link `example` will unexpectedly move to the second example heading. Ref: #27461 (comment) Co-authored-by: silverwind <me@silverwind.io>
nanguanlin6
force-pushed
the
improve_docs
branch
from
a20f83b to
2b14dd7
Compare
6543
added
the
reviewed/wait-merge
GiteaBot
removed
the
reviewed/wait-merge
zjjhot
added a commit
to zjjhot/gitea
that referenced
this pull request
Oct 10, 2023
* giteaofficial/main: Respect SSH.KeygenPath option when calculating ssh key fingerprints (go-gitea#27536) Remove max-width and add hide text overflow (go-gitea#27359) Fix `environment-to-ini` inherited key bug (go-gitea#27543) Improve docs about register/run as a service (go-gitea#27461) api: GetPullRequestCommits: return file list (go-gitea#27483) switch to using official AWS step in release nightly (go-gitea#27532) Improve file history UI and fix URL escaping bug (go-gitea#27531) Improve dropdown's behavior when there is a search input in menu (go-gitea#27526) Simplify `contrib/backport` (go-gitea#27520) Add docs section for sub-paths with the container registry (go-gitea#27505) Document our new labeling strategy (go-gitea#27523) [skip ci] Updated translations via Crowdin Restore warning commit status (go-gitea#27504) Update labeler to match new labeling system (go-gitea#27525) Apply to become a maintainer (go-gitea#27522) Remove unnecessary desc for openssh key cron task (go-gitea#27515) Tweak labeler config (go-gitea#27502) Add hover background to wiki list page (go-gitea#27507) [FIX] missing ctx in new_form (go-gitea#27514)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As title