Merge pull request #40863 from gian1200/feature/fix-readme-warnings

Fix some markdownlint warnings on .md files
quarkusio · Jun 11, 2024 · f0d4d20 · f0d4d20
2 parents 9701b25 + 840c1f3
commit f0d4d20
Show file tree

Hide file tree

Showing 22 changed files with 149 additions and 136 deletions.
diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic.md
@@ -8,9 +8,11 @@ assignees: ''
 ---
 
 ### Description
+
 (A high level description of the work)
 
 ### Analysis
+
 (links to analysis docs containing architecture design work, requirements gathering, etc)
 
 <!-- task list will be automatically generated from below. 

diff --git a/ACTIONS.md b/ACTIONS.md
@@ -1,23 +1,22 @@
 # GitHub Actions setup
 
-Quarkus is built using GitHub Actions, with a mix of hosted and self-hosted runners. 
-
-## Setting up a new self-hosted runner on Mac M1 
+Quarkus is built using GitHub Actions, with a mix of hosted and self-hosted runners.
 
+## Setting up a new self-hosted runner on Mac M1
 
 ### Non-root user
 
-GitHub Actions should not run with administrator privileges, so will need to be run in a dedicated account. 
+GitHub Actions should not run with administrator privileges, so will need to be run in a dedicated account.
 Make an account for the actions runner. The steps below assume the account has the name `githubactions`.
-It's usually easiest to do account creation in the GUI, via a VNC connection. Users are managed in 
+It's usually easiest to do account creation in the GUI, via a VNC connection. Users are managed in
 the **Users and Groups** section of the Settings app.
 
 *Grant administrator privileges to the account* (we will remove them later).
 
-
 ### System utilities
 
-As administrator, install homebrew. 
+As administrator, install homebrew.
+
 ```shell
 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
 ```
@@ -30,9 +29,9 @@ brew install gradle
 brew install podman
 ```
 
-### Podman setup 
+### Podman setup
 
-Podman needs some [extra configuration](https://quarkus.io/guides/podman) to work with test containers and dev services. 
+Podman needs some [extra configuration](https://quarkus.io/guides/podman) to work with test containers and dev services.
 
 Now log in to the account you created to run the actions.
 As the `githubactions` user (but with administrator privileges)
@@ -41,7 +40,8 @@ As the `githubactions` user (but with administrator privileges)
 PODMAN_VERSION=`podman -v | sed 's/[a-zA-Z ]*//'`
 sudo /opt/homebrew/Cellar/podman/$PODMAN_VERSION/bin/podman-mac-helper install
 ```
-The podman helper install seems to be per-user, but it needs to be done with administrator privileges. 
+
+The podman helper install seems to be per-user, but it needs to be done with administrator privileges.
 
 Again as the `githubactions` user, edit ~/.testcontainers.properties and add the following line: `ryuk.container.privileged=true`
 
@@ -63,8 +63,8 @@ rpm-ostree install qemu-user-static
 systemctl reboot
 ```
 
-Now remove administrator privileges from the `githubactions` user. 
-As with the user creation, it's usually easiest to do this in the GUI. 
+Now remove administrator privileges from the `githubactions` user.
+As with the user creation, it's usually easiest to do this in the GUI.
 
 ### Rosetta
 
@@ -73,22 +73,22 @@ A fresh install of macOS will not have Rosetta installed, so Intel binaries cann
 ```bash
 softwareupdate --install-rosetta --agree-to-license
 ```
+
 ### Stand up the actions runner
 
 #### Download the runner scripts
 
-GitHub provides an installation package of customized runner scripts for each repository. 
+GitHub provides an installation package of customized runner scripts for each repository.
 Follow [the instructions](https://docs.github.com/en/actions/hosting-your-own-runners/adding-self-hosted-runners)
-to install the scripts for the repository to be built. 
+to install the scripts for the repository to be built.
 
 Choose the default group, a descriptive name, and the default work folder. Add a label `macos-arm64-latest`.
 If you forget the label, it will need to be added [through the UI](https://docs.github.com/en/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners).
 
-
 #### Cleanup and setup logic
 
-Self-hosted runners do not run on ephemeral hardware, and so workflow runs may need to clean up. 
-We also need to start a podman machine before the job if one is not already running. 
+Self-hosted runners do not run on ephemeral hardware, and so workflow runs may need to clean up.
+We also need to start a podman machine before the job if one is not already running.
 
 To create cleanup and setup scripts and hooks, run:
 
@@ -100,24 +100,22 @@ echo ACTIONS_RUNNER_HOOK_JOB_COMPLETED=/Users/githubactions/runner-cleanup.sh >>
 echo ACTIONS_RUNNER_HOOK_JOB_STARTED=/Users/githubactions/podman-start.sh >> .env
 ```
 
-
 In the same script, we also ensure that the podman machine is running before jobs execute.
 
-#### Start the runner 
+#### Start the runner
 
-To test the runner, run 
+To test the runner, run
 
 `run.sh`
 
-Once you're happy the runner is processing builds correctly, it's time to create it as a daemon. 
+Once you're happy the runner is processing builds correctly, it's time to create it as a daemon.
 
 ### Start the service on reboot
 
-Note that GitHub have scripts for this, but theirs run as LaunchAgents, not LaunchDaemons. 
+Note that GitHub have scripts for this, but theirs run as LaunchAgents, not LaunchDaemons.
 LaunchAgents run when a user logs in, and LaunchDaemons run on boot, so the daemon option seems preferable.
 
-
-As administrator, `sudo vi /Library/LaunchDaemons/actions.runner.quarkusio-quarkus.macstadium-m1.plist`. 
+As administrator, `sudo vi /Library/LaunchDaemons/actions.runner.quarkusio-quarkus.macstadium-m1.plist`.
 
 Then add the following:
 
@@ -164,10 +162,10 @@ Then add the following:
 </plist>
 ```
 
-Finally, run 
+Finally, run
 
 ```shell
 sudo launchctl load -w /Library/LaunchDaemons/actions.runner.quarkusio-quarkus.macstadium-m1.plist
 ```
 
-You can check the logs in `/tmp/github.runner.plist.stdout` to confirm everything is working.
+You can check the logs in `/tmp/github.runner.plist.stdout` to confirm everything is working.
diff --git a/ADOPTERS.md b/ADOPTERS.md
@@ -4,31 +4,31 @@ ADOPTERS
 PUBLIC REFERENCES
 -----------------
 
-This document lists the organizations that use Quarkus based on public information available in blog posts and videos. 
+This document lists the organizations that use Quarkus based on public information available in blog posts and videos.
 If any organization would like get added or removed please make a pull request by following these guidelines:
 
 * Please don't include your organization's logo or other trademarked material
 * Add a reference (link to a public blog post, video, slides, etc) mentioning that Quarkus is used
 
-| Organization          | Reference                                                                         |
-|-----------------------|-----------------------------------------------------------------------------------|
-|Abraxas Informatik AG  | https://quarkus.io/blog/abraxas-customer-story/                                   |
-|Artes                  | https://horvie.github.io/adopt-quarkus/                                           |
-|B<>com                 | https://5g.labs.b-com.com/                                                        |
-|Carrefour              | https://horizons.carrefour.com/efficient-java-in-the-cloud-with-quarkus           |
-|Cytech                 | https://quarkus.io/blog/cytech-customer-story/                                    |
-|DataCater              | https://quarkus.io/blog/datacater-uses-quarkus-to-make-data-streaming-accessible/ |
-|Decathlon              | https://quarkus.io/blog/decathlon-user-story/                                     |
-|Ennovative Solutions   | https://quarkus.io/blog/ennovativesolutions-uses-quarkus-with-aws-lambda/         |
-|GoWithFlow             | https://quarkus.io/blog/gowithflow-chooses-quarkus-to-deliver-fast-to-production/ |
-|Lufthansa Technik      | https://quarkus.io/blog/aviatar-experiences-significant-savings/                  |
-|Logicdrop              | https://quarkus.io/blog/logicdrop-customer-story/                                 |
-|[Microcks](https://landscape.cncf.io/?selected=microcks)               | https://itnext.io/mocking-and-contract-testing-in-your-inner-loop-with-microcks-part-3-quarkus-devservice-ftw-a14b807737be            |
-|Payair                 | https://quarkus.io/blog/why-did-payair-technologies-switch-to-quarkus/            |
-|Sedona                 | https://quarkus.io/blog/sedona-rewrites-insurance-premium/                        |
-|Stargate               | https://quarkus.io/blog/stargate-selects-quarkus-for-its-v2-implementation/       |
-|Suomen Asiakastieto Oy | https://quarkus.io/blog/asiakastieto-chooses-quarkus-for-microservices/           |
-|Talkdesk               | https://quarkus.io/blog/talkdesk-chooses-quarkus-for-fast-innovation/             |
-|UTN Faculty Córdoba    | https://www.frc.utn.edu.ar/computos/tech/                                         |
-|Vodafone Greece        | https://quarkus.io/blog/vodafone-greece-replaces-spring-boot/                     |
-|Wipro                  | https://quarkus.io/blog/wipro-customer-story/                                     |
+| Organization          | Reference                                                                           |
+|-----------------------|-------------------------------------------------------------------------------------|
+|Abraxas Informatik AG  | <https://quarkus.io/blog/abraxas-customer-story/>                                   |
+|Artes                  | <https://horvie.github.io/adopt-quarkus/>                                           |
+|B<>com                 | <https://5g.labs.b-com.com/>                                                        |
+|Carrefour              | <https://horizons.carrefour.com/efficient-java-in-the-cloud-with-quarkus>           |
+|Cytech                 | <https://quarkus.io/blog/cytech-customer-story/>                                    |
+|DataCater              | <https://quarkus.io/blog/datacater-uses-quarkus-to-make-data-streaming-accessible/> |
+|Decathlon              | <https://quarkus.io/blog/decathlon-user-story/>                                     |
+|Ennovative Solutions   | <https://quarkus.io/blog/ennovativesolutions-uses-quarkus-with-aws-lambda/>         |
+|GoWithFlow             | <https://quarkus.io/blog/gowithflow-chooses-quarkus-to-deliver-fast-to-production/> |
+|Lufthansa Technik      | <https://quarkus.io/blog/aviatar-experiences-significant-savings/>                  |
+|Logicdrop              | <https://quarkus.io/blog/logicdrop-customer-story/>                                 |
+|[Microcks](https://landscape.cncf.io/?selected=microcks)               | <https://itnext.io/mocking-and-contract-testing-in-your-inner-loop-with-microcks-part-3-quarkus-devservice-ftw-a14b807737be>            |
+|Payair                 | <https://quarkus.io/blog/why-did-payair-technologies-switch-to-quarkus/>            |
+|Sedona                 | <https://quarkus.io/blog/sedona-rewrites-insurance-premium/>                        |
+|Stargate               | <https://quarkus.io/blog/stargate-selects-quarkus-for-its-v2-implementation/>       |
+|Suomen Asiakastieto Oy | <https://quarkus.io/blog/asiakastieto-chooses-quarkus-for-microservices/>           |
+|Talkdesk               | <https://quarkus.io/blog/talkdesk-chooses-quarkus-for-fast-innovation/>             |
+|UTN Faculty Córdoba    | <https://www.frc.utn.edu.ar/computos/tech/>                                         |
+|Vodafone Greece        | <https://quarkus.io/blog/vodafone-greece-replaces-spring-boot/>                     |
+|Wipro                  | <https://quarkus.io/blog/wipro-customer-story/>                                     |