Skip to content

docs: reformat markdown#15650

Merged
rmuir merged 2 commits intoapache:mainfrom
rmuir:reformat-markdown
Feb 1, 2026
Merged

docs: reformat markdown#15650
rmuir merged 2 commits intoapache:mainfrom
rmuir:reformat-markdown

Conversation

@rmuir
Copy link
Member

@rmuir rmuir commented Jan 31, 2026

Reformat all the files, remove the exclusion.

Also fix a bug in the check, so it will still fail if there are markdown problems that couldn't automatically be fixed. Most problems are autofixed without manual effort.

Followup to #15629

Reformat all the files, remove the exclusion.

Also fix a bug in the check, so it will still fail if there are markdown
problems that couldn't automatically be fixed. Most problems are
autofixed without manual effort.
@rmuir rmuir added the skip-changelog Apply to PRs that don't need a changelog entry, stopping the automated changelog check. label Jan 31, 2026
@rmuir

This comment was marked as outdated.

The default is a 2-space indent, but editorconfig says 4. Make these
consistent so there is the least friction for developers.
Copy link
Contributor

@uschindler uschindler left a comment

Choose a reason for hiding this comment

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

Looks fine! The explicit <> around links is not really needed in our case, but of course it is good style. The Markdown-Converters we use are Github style and detect links automatically. We could disable this in out gradle scripts that build the documentation:

@rmuir rmuir merged commit 999c1a4 into apache:main Feb 1, 2026
14 checks passed
finnroblin pushed a commit to finnroblin/lucene that referenced this pull request Feb 2, 2026
* docs: reformat markdown

Reformat all the files, remove the exclusion.

Also fix a bug in the check, so it will still fail if there are markdown
problems that couldn't automatically be fixed. Most problems are
autofixed without manual effort.

* build: fix rumdl configuration to match editorconfig (indent=4)

The default is a 2-space indent, but editorconfig says 4. Make these
consistent so there is the least friction for developers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

module:luke skip-changelog Apply to PRs that don't need a changelog entry, stopping the automated changelog check.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants