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

Fix some markdownlint warnings on .md files #40863

Merged
merged 1 commit into from
Jun 11, 2024

Conversation

gian1200
Copy link
Contributor

@gian1200 gian1200 commented May 28, 2024

Closes #40147

Fixed some non intrusive warnings: in some .md files

  • MD009: Remove extra trailing spaces
  • MD031: Add new line
  • MD034: Add wrappers to URL (<>)
  • MD038: Remove extra spaces from code span element
  • MD040: Specify language on code block
  • MD051: Fix Link fragments in CONTRIBUTING.md index (rolled back)

PS:

  • markdown-toc has a bug where generates bad links when special characters are used in headings
  • CONTRIBUTING.md still has 192 warnings that should be reviewed:
    • MD001/heading-increment: Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]
    • MD004/ul-style: Unordered list style [Expected: dash; Actual: asterisk]
    • MD007/ul-indent: Unordered list indentation [Expected: 2; Actual: 4]
    • MD033/no-inline-html: Inline HTML [Element: a]
    • MD036/no-emphasis-as-heading: Emphasis used instead of a heading
    • MD040/fenced-code-language: Fenced code blocks should have a language specified
    • MD049/emphasis-style: Emphasis style [Expected: asterisk; Actual: underscore]

@quarkus-bot quarkus-bot bot added area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/documentation area/infinispan Infinispan area/infra-automation anything related to CI, bots, etc. that are used to automated our infrastructure area/jbang Issues related to when using jbang.dev with Quarkus area/keycloak area/logging area/oidc area/platform Issues related to definition and interaction with Quarkus Platform labels May 28, 2024
Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

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

Thanks for taking the time to prepare this PR.

All changes look good except the change to the TOC: given it's automatically generated, I don't think we want to adjust it.

CONTRIBUTING.md Outdated Show resolved Hide resolved

This comment has been minimized.

This comment has been minimized.

Copy link

quarkus-bot bot commented Jun 6, 2024

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit 840c1f3.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

You can consult the Develocity build scans.


Flaky tests - Develocity

⚙️ JVM Tests - JDK 17

📦 integration-tests/rest-client

io.quarkus.it.rest.client.wronghost.ExternalWrongHostUsingVerifyHostTestCase.restClient - History

  • Read timed out - java.net.SocketTimeoutException
java.net.SocketTimeoutException: Read timed out
	at java.base/sun.nio.ch.NioSocketImpl.timedRead(NioSocketImpl.java:288)
	at java.base/sun.nio.ch.NioSocketImpl.implRead(NioSocketImpl.java:314)
	at java.base/sun.nio.ch.NioSocketImpl.read(NioSocketImpl.java:355)
	at java.base/sun.nio.ch.NioSocketImpl$1.read(NioSocketImpl.java:808)
	at java.base/java.net.Socket$SocketInputStream.read(Socket.java:966)
	at org.apache.http.impl.io.AbstractSessionInputBuffer.fillBuffer(AbstractSessionInputBuffer.java:161)
	at org.apache.http.impl.io.SocketInputBuffer.fillBuffer(SocketInputBuffer.java:82)

@gian1200 gian1200 requested a review from gsmet June 6, 2024 23:42
@gsmet gsmet merged commit f0d4d20 into quarkusio:main Jun 11, 2024
53 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.12 - main milestone Jun 11, 2024
gsmet added a commit to gsmet/quarkus that referenced this pull request Jun 11, 2024
Some links were actually invalid because we were using an outdated
online version of the TOC tooling.

As reported by @gian1200 in quarkusio#40863.
@gian1200 gian1200 deleted the feature/fix-readme-warnings branch June 11, 2024 14:19
holly-cummins pushed a commit to holly-cummins/quarkus that referenced this pull request Jul 31, 2024
Some links were actually invalid because we were using an outdated
online version of the TOC tooling.

As reported by @gian1200 in quarkusio#40863.
danielsoro pushed a commit to danielsoro/quarkus that referenced this pull request Sep 20, 2024
Some links were actually invalid because we were using an outdated
online version of the TOC tooling.

As reported by @gian1200 in quarkusio#40863.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/documentation area/infinispan Infinispan area/infra-automation anything related to CI, bots, etc. that are used to automated our infrastructure area/jbang Issues related to when using jbang.dev with Quarkus area/keycloak area/logging area/maven area/oidc area/platform Issues related to definition and interaction with Quarkus Platform triage/flaky-test
Projects
Development

Successfully merging this pull request may close these issues.

Markdownlint flags some minor warnings on README.md generated by code.quarkus
2 participants