chore: added Markdownlint configuration (#2299)

This commit is contained in:
Fabrice Flore-Thébault 2023-05-03 15:57:27 +02:00 committed by GitHub
parent 668fd4eec8
commit b0f1cdf535
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 144 additions and 67 deletions

12
.markdownlint.yaml Normal file
View file

@ -0,0 +1,12 @@
# We increment heading levels my more by one level at a time for the Procedure, Verification headings:
MD001: false
# We do not limit line length:
MD013: false
# We always use Dollar signs before commands:
MD014: false
# We have multiple headings with the same content (Prerequisites, Procedure, Verification)
MD024: false
# We have multiple top-level headings in the same document to set different page title and navigation title:
MD025: false
# We allow inline HTML (icon):
MD033: false

View file

@ -56,6 +56,8 @@
"watch": "node scripts/watch.cjs",
"format:check": "prettier --check \"{extensions,packages,tests,types}/**/*.{ts,svelte}\" \"extensions/*/scripts/build.js\" \"website/**/*.{md,js}\" \"website/src/**/*.{css,tsx}\"",
"format:fix": "prettier --write \"{extensions,packages,tests,types}/**/*.{ts,svelte}\" \"extensions/*/scripts/build.js\" \"website/**/*.{md,js}\" \"website/src/**/*.{css,tsx}\"",
"markdownlint:check": "markdownlint-cli2 \"website/**/*.md\" \"#website/node_modules\"",
"markdownlint:fix": "markdownlint-cli2-fix \"website/**/*.md\" \"#website/node_modules\"",
"lint:check": "eslint . --ext js,ts,tsx",
"lint:fix": "eslint . --fix --ext js,ts,tsx",
"svelte:check": "svelte-check",

View file

@ -2,13 +2,13 @@
### Install the project dependencies
```
```shell-session
$ yarn install
```
### Local Development of the website / documentation
```
```shell-session
$ yarn start
```
@ -16,7 +16,7 @@ This command starts a local development server and opens up a browser window. Mo
### Build
```
```shell-session
$ yarn build
```
@ -26,13 +26,13 @@ This command generates static content into the `build` directory and can be serv
Using SSH:
```
```shell-session
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
```shell-session
$ GIT_USER=<Your GitHub username> yarn deploy
```

View file

@ -17,7 +17,7 @@ The challenges are to run a desktop tool (Podman Desktop) and running a containe
## Defining image of the container
The first thing is in the choice of the image for the container. It is possible to pick-up a default image and add some features but there is no existing feature for Podman at https://github.com/devcontainers/features/tree/main/src and most of the features are expecting to run on top of Debian/Ubuntu
The first thing is in the choice of the image for the container. It is possible to pick-up a default image and add some features but there is no existing feature for Podman at <https://github.com/devcontainers/features/tree/main/src> and most of the features are expecting to run on top of Debian/Ubuntu
If you are not interested in how to setup the image, jump to the [next section](#configure-the-devcontainer-using-devcontainerjson).
@ -119,14 +119,14 @@ ENV _CONTAINERS_USERNS_CONFIGURED=""
Make sure Podman will create the socket in an expected directory:
```
```docker
# socket path for podman
ENV XDG_RUNTIME_DIR=/run/user/1000
```
OK ! we have a custom Containerfile providing all the tools to build and run Podman Desktop (using VNC for the display), run Podman and run Electron.
The current file is available at https://github.com/containers/podman-desktop/blob/main/.devcontainer/.parent/Containerfile
The current file is available at <https://github.com/containers/podman-desktop/blob/main/.devcontainer/.parent/Containerfile>
Let's configure the DevContainer.
@ -282,7 +282,7 @@ After all post-creation steps, the `Preview` browser inside the VS Code editor w
As a user, opening a workspace with all what we configured is done using a single click.
Go to https://github.com/containers/podman-desktop then click on the `< > Code` dropdown and click on `Create codespace on main` button.
Go to <https://github.com/containers/podman-desktop> then click on the `< > Code` dropdown and click on `Create codespace on main` button.
![Open Codespace](img/develop-podman-using-codespaces/codespaces-click-repository.png)

View file

@ -99,7 +99,7 @@ For most users on Linux, there is no tray icon support. In this situation, when
- Fixed use of the full height of the screen when displaying log in the details of a container. ([#946](https://github.com/containers/podman-desktop/discussions/946))
- Fixed First start of Podman Desktop on flatpak was not seeing the podman engine ([#860](https://github.com/containers/podman-desktop/pull/860))
## Community Thank You!
## Community Thank You
🎉 Wed like to say a big thank you to everyone who helped to make Podman Desktop 0.10 even better:

View file

@ -209,7 +209,7 @@ Several of other improvements have been made to the documentation and the websit
- Fixed registry URL not aligned with header - [#1205](https://github.com/containers/podman-desktop/pull/1205)
- Moved SVGs to reusable components - [#1211](https://github.com/containers/podman-desktop/pull/1211)
** Extensions API has also been improved in this new release: **
**Extensions API has also been improved in this new release:**
- (extension-api): Allows to register a factory for kubernetes connection objects (like for container connections) - [#1040](https://github.com/containers/podman-desktop/pull/1040)
- (extension-api): List or inspect containers, be notified on events - [#1041](https://github.com/containers/podman-desktop/pull/1041)
@ -223,7 +223,7 @@ Several of other improvements have been made to the documentation and the websit
---
## Community Thank You!
## Community Thank You
🎉 Wed like to say a big thank you to everyone who helped to make Podman Desktop 0.11 even better:

View file

@ -137,7 +137,7 @@ The documentation had many editorial reviews, and new content.
---
## Community Thank You!
## Community Thank You
🎉 Wed like to say a big thank you to everyone who helped to make Podman Desktop 0.12 even better:

View file

@ -46,7 +46,7 @@ Podman Desktop requires [Podman Engine](https://docs.podman.io/en/latest/index.h
1. After the installation is complete, close the installation program. Podman Engine has been installed and you are now ready to use Podman Desktop.
## Installing Podman Desktop on MacOS using [brew](https://brew.sh/).
## Installing Podman Desktop on MacOS using [brew](https://brew.sh/)
:::infoPrerequisite

View file

@ -29,18 +29,19 @@ Consider installing the Podman Preset in OpenShift Local rather than [installing
2. Select the Podman container runtime preset:
```
```shell-session
$ crc config set preset podman
```
3. Set up your host machine for Red Hat OpenShift Local:
```
```shell-session
$ crc setup
```
4. Start the Red Hat OpenShift instance:
```
```shell-session
$ crc start
```

View file

@ -32,6 +32,6 @@ With Podman Desktop, you can deploy a container to your Kubernetes cluster.
- On the **Deploy generated pod to Kubernetes** screen, the created pod status is _Phase: Running_
![](img/deploying-a-container.png)
![Deploying a container](img/deploying-a-container.png)
- Go to **Containers**: your pod is in the list.

View file

@ -32,6 +32,6 @@ With Podman Desktop, you can deploy a pod to your Kubernetes cluster.
- On the **Deploy generated pod to Kubernetes** screen, the created pod status is _Phase: Running_
![](img/deploying-a-pod.png)
![Deplying a pod](img/deploying-a-pod.png)
- Go to **Pods**: your pod is in the list.

View file

@ -19,6 +19,7 @@ tags: [migrating-to-kubernetes, kind]
1. **<icon icon="fa-solid fa-cog" size="lg" /> Settings > Resources** contain a **Kind** tile.
![Kind resource tile](img/kind-resource.png)
1. You can run the `kind` CLI:
```shell-session
$ kind get clusters
```

View file

@ -31,7 +31,7 @@ Consider emulating Docker CLI with Podman to migrate transparently to Podman.
2. (Optional) Create an empty `/etc/containers/nodocker` file to avoid the `Emulate Docker CLI using podman.` message when running the script.
```
```shell-session
# touch /etc/containers/nodocker
```

View file

@ -47,7 +47,7 @@ The service redirects `/var/run/docker` to the fixed user-assigned UNIX socket l
Example:
```
```shell-session
$ podman-mac-helper run -it <your_container> bash
```

View file

@ -16,7 +16,7 @@ The tool connects to Podman using the socket on the host on macOS and on a named
This is available only on Podman 4.0.2+
So, please check your version and update.
On Windows, the named pipe is `//./pipe/docker_engine` when Docker Desktop is not installed. It will be solved by https://github.com/containers/podman/issues/13502 / https://github.com/containers/podman/pull/13655. During that time, you may start Docker Desktop so the named pipe is the one expected.
On Windows, the named pipe is `//./pipe/docker_engine` when Docker Desktop is not installed. It will be solved by <https://github.com/containers/podman/issues/13502> / <https://github.com/containers/podman/pull/13655>. During that time, you might start Docker Desktop so the named pipe is the one expected.
#### Check connection
@ -50,17 +50,17 @@ Twitter: @Podman_io
### Unable to locate Podman Engine
#### Issue:
#### Issue
Despite having Podman Engine installed, you may receive an error as follows -
`Error: No such keg: /usr/local/Cellar/podman`
or any similar error denoting that Podman Engine does not exist.
#### Explanation:
#### Explanation
The Podman Installer and Homebrew use different locations to store the Podman Engine files in the file system. For example, Podman Installer installs Podman Engine in the path `/opt/podman` whereas Homebrew uses the path `/usr/local` for macOS Intel, `/opt/homebrew` for Apple Silicon and `/home/linuxbrew/.linuxbrew` for Linux.
#### Solution:
#### Solution
To check where exactly is your Podman Engine installed, run the command-
@ -88,56 +88,41 @@ You can now proceed for a fresh installation of Podman Desktop
### Unable to see information about active containers
#### Issue:
#### Issue
In this scenario, the screen may be displaying "No Containers" as shown below despite active containers runnning in the background.
![img](img/containers_error.png)
#### Solution:
#### Solution
There are three ways to work this out.
1. To solve this issue, open the Terminal and run the following commands-
```sh
podman machine stop
```
```shell-session
podman machine stop
podman machine start
```
and then,
2. If this does not work for you, you might proceed with the following commands-
```sh
podman machine start
```
2. If this does not work for you, you may proceed with the following commands-
```sh
podman machine rm
```
and then,
```sh
podman machine init
```
```shell-session
$ podman machine rm
$ podman machine init
```
3. If both of the abovementioned steps don't work for you, run the following commands-
```sh
rm -rf ~/.local/share/containers/podman
```
```shell-session
$ rm -rf ~/.local/share/containers/podman
$ rm -rf ~/.config/containers/
```
and then,
```sh
rm -rf ~/.config/containers/
```
After this, you can start off again by initializing a new Podman Machine and loading up the containers.
After this, you can start off again by initializing a new Podman Machine and loading up the containers.
### Unable to set custom binary path for Podman on macOS
#### Issue:
#### Issue
When setting a custom binary path (under Preferences -> Custom binary path), Podman is unable to find `gvproxy` and `podman-mac-helper`:
@ -145,7 +130,7 @@ When setting a custom binary path (under Preferences -> Custom binary path), Pod
Error: unable to start host networking: "could not find \"gvproxy\" in one of [/usr/local/opt/podman/libexec /opt/homebrew/bin /opt/homebrew/opt/podman/libexec /usr/local/bin /usr/local/libexec/podman /usr/local/lib/podman /usr/libexec/podman /usr/lib/podman $BINDIR/../libexec/podman]. To resolve this error, set the helper_binaries_dir key in the `[engine]` section of containers.conf to the directory containing your helper binaries."
```
#### Solution:
#### Solution
1. Download `gvproxy` from the [gvisor-tap-vsock release page](https://github.com/containers/gvisor-tap-vsock/releases).
2. Build the `podman-mac-helper` from the source code on the [Podman GitHub page](https://github.com/containers/podman/tree/main/cmd/podman-mac-helper).
@ -161,7 +146,7 @@ helper_binaries_dir=["/Users/user/example_directory"]
### Warning about Docker compatibility mode
#### Issue:
#### Issue
When running the Podman provider, a warning shows regarding Docker compatibility mode on the dashboard:
@ -174,7 +159,7 @@ This may appear when either:
- The Docker socket is not mounted correctly
- Docker Desktop is also being ran at the same time
#### Solution:
#### Solution
**On macOS:**
@ -239,7 +224,7 @@ This will stop the Podman Machine for you.
If you are using an Apple Silicon and brew, you might encounter the following error when starting Podman from Podman Desktop
```
```shell-session
Error: qemu exited unexpectedly with exit code 1, stderr: qemu-system-x86_64: invalid accelerator hvf
qemu-system-x86_64: falling back to tcg
qemu-system-x86_64: unable to find CPU model 'host'
@ -260,9 +245,9 @@ Then run a terminal in native mode (default) and install Podman machine `brew in
Finally clean the Podman machine VMs that had been previously created, and create new ones.
```
podman machine rm podman-machine-default
podman machine init
```shell-session
$ podman machine rm podman-machine-default
$ podman machine init
```
You should be a happy camper from here.

View file

@ -36,6 +36,8 @@
"@docusaurus/module-type-aliases": "2.4.0",
"@tsconfig/docusaurus": "^1.0.7",
"autoprefixer": "^10.4.14",
"markdownlint": "^0.28.2",
"markdownlint-cli2": "^0.7.1",
"postcss": "^8.4.23",
"tailwindcss": "^3.3.2",
"typescript": "^5.0.4"

View file

@ -6126,7 +6126,7 @@ entities@^2.0.0:
resolved "https://registry.yarnpkg.com/entities/-/entities-2.2.0.tgz#098dc90ebb83d8dffa089d55256b351d34c4da55"
integrity sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==
entities@^3.0.1:
entities@^3.0.1, entities@~3.0.1:
version "3.0.1"
resolved "https://registry.yarnpkg.com/entities/-/entities-3.0.1.tgz#2b887ca62585e96db3903482d336c1006c3001d4"
integrity sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==
@ -7067,6 +7067,17 @@ globby@10.0.1:
merge2 "^1.2.3"
slash "^3.0.0"
globby@13.1.4:
version "13.1.4"
resolved "https://registry.yarnpkg.com/globby/-/globby-13.1.4.tgz#2f91c116066bcec152465ba36e5caa4a13c01317"
integrity sha512-iui/IiiW+QrJ1X1hKH5qwlMQyv34wJAYwH1vrf8b9kBA4sNiif3gKsMHa+BrdnOpEudWjpotfa7LrTzB1ERS/g==
dependencies:
dir-glob "^3.0.1"
fast-glob "^3.2.11"
ignore "^5.2.0"
merge2 "^1.4.1"
slash "^4.0.0"
globby@^11.0.1, globby@^11.0.4, globby@^11.1.0:
version "11.1.0"
resolved "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz"
@ -8546,6 +8557,13 @@ lines-and-columns@^1.1.6:
resolved "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz"
integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==
linkify-it@^4.0.1:
version "4.0.1"
resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-4.0.1.tgz#01f1d5e508190d06669982ba31a7d9f56a5751ec"
integrity sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw==
dependencies:
uc.micro "^1.0.1"
load-script@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/load-script/-/load-script-1.0.0.tgz#0491939e0bee5643ee494a7e3da3d2bac70c6ca4"
@ -8740,6 +8758,47 @@ markdown-escapes@^1.0.0:
resolved "https://registry.yarnpkg.com/markdown-escapes/-/markdown-escapes-1.0.4.tgz#c95415ef451499d7602b91095f3c8e8975f78535"
integrity sha512-8z4efJYk43E0upd0NbVXwgSTQs6cT3T06etieCMEg7dRbzCbxUCK/GHlX8mhHRDcp+OLlHkPKsvqQTCvsRl2cg==
markdown-it@13.0.1:
version "13.0.1"
resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-13.0.1.tgz#c6ecc431cacf1a5da531423fc6a42807814af430"
integrity sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q==
dependencies:
argparse "^2.0.1"
entities "~3.0.1"
linkify-it "^4.0.1"
mdurl "^1.0.1"
uc.micro "^1.0.5"
markdownlint-cli2-formatter-default@0.0.4:
version "0.0.4"
resolved "https://registry.yarnpkg.com/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.4.tgz#81e26b0a50409c0357c6f0d38d8246946b236fab"
integrity sha512-xm2rM0E+sWgjpPn1EesPXx5hIyrN2ddUnUwnbCsD/ONxYtw3PX6LydvdH6dciWAoFDpwzbHM1TO7uHfcMd6IYg==
markdownlint-cli2@^0.7.1:
version "0.7.1"
resolved "https://registry.yarnpkg.com/markdownlint-cli2/-/markdownlint-cli2-0.7.1.tgz#42cd126f640c1bd0b820759c29b47c06fb2246cf"
integrity sha512-N58lw50Ws0WOfCc07B9dPKMnPMbIj6ZCMlszZLVfxBwKN/M+WZqXLdOHyRL2BWCZ3APBxQN9qDEw7Vf1PRqFkg==
dependencies:
globby "13.1.4"
markdownlint "0.28.2"
markdownlint-cli2-formatter-default "0.0.4"
micromatch "4.0.5"
strip-json-comments "5.0.0"
yaml "2.2.2"
markdownlint-micromark@0.1.2:
version "0.1.2"
resolved "https://registry.yarnpkg.com/markdownlint-micromark/-/markdownlint-micromark-0.1.2.tgz#5520e04febffa46741875a2f297509ffdb561f5c"
integrity sha512-jRxlQg8KpOfM2IbCL9RXM8ZiYWz2rv6DlZAnGv8ASJQpUh6byTBnEsbuMZ6T2/uIgntyf7SKg/mEaEBo1164fQ==
markdownlint@0.28.2, markdownlint@^0.28.2:
version "0.28.2"
resolved "https://registry.yarnpkg.com/markdownlint/-/markdownlint-0.28.2.tgz#ea31586a02fe3a06403ecafbbe22d77e363c8ed5"
integrity sha512-yYaQXoKKPV1zgrFsyAuZPEQoe+JrY9GDag9ObKpk09twx4OCU5lut+0/kZPrQ3W7w82SmgKhd7D8m34aG1unVw==
dependencies:
markdown-it "13.0.1"
markdownlint-micromark "0.1.2"
matcher@^3.0.0:
version "3.0.0"
resolved "https://registry.npmjs.org/matcher/-/matcher-3.0.0.tgz"
@ -8801,7 +8860,7 @@ mdn-data@2.0.14:
resolved "https://registry.yarnpkg.com/mdn-data/-/mdn-data-2.0.14.tgz#7113fc4281917d63ce29b43446f701e68c25ba50"
integrity sha512-dn6wd0uw5GsdswPFfsgMp5NSB0/aDe6fK94YJV/AJDYXL6HVLWBsxeq7js7Ad+mU2K9LAlwpk6kN2D5mwCPVow==
mdurl@^1.0.0:
mdurl@^1.0.0, mdurl@^1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-1.0.1.tgz#fe85b2ec75a59037f2adfec100fd6c601761152e"
integrity sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=
@ -9041,7 +9100,7 @@ micromark@^3.1.0:
micromark-util-types "^1.0.1"
uvu "^0.5.0"
micromatch@^4.0.2, micromatch@^4.0.4, micromatch@^4.0.5:
micromatch@4.0.5, micromatch@^4.0.2, micromatch@^4.0.4, micromatch@^4.0.5:
version "4.0.5"
resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.5.tgz#bc8999a7cbbf77cdc89f132f6e467051b49090c6"
integrity sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==
@ -11770,6 +11829,11 @@ strip-indent@^3.0.0:
dependencies:
min-indent "^1.0.0"
strip-json-comments@5.0.0:
version "5.0.0"
resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-5.0.0.tgz#ec101b766476a703031bc607e3c712569de2aa06"
integrity sha512-V1LGY4UUo0jgwC+ELQ2BNWfPa17TIuwBLg+j1AA/9RPzKINl1lhxVEu2r+ZTTO8aetIsUzE5Qj6LMSBkoGYKKw==
strip-json-comments@^3.1.0, strip-json-comments@^3.1.1:
version "3.1.1"
resolved "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz"
@ -12352,6 +12416,11 @@ ua-parser-js@^0.7.30:
resolved "https://registry.yarnpkg.com/ua-parser-js/-/ua-parser-js-0.7.33.tgz#1d04acb4ccef9293df6f70f2c3d22f3030d8b532"
integrity sha512-s8ax/CeZdK9R/56Sui0WM6y9OFREJarMRHqLB2EwkovemBxNQ+Bqu8GAsUnVcXKgphb++ghr/B2BZx4mahujPw==
uc.micro@^1.0.1, uc.micro@^1.0.5:
version "1.0.6"
resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.6.tgz#9c411a802a409a91fc6cf74081baba34b24499ac"
integrity sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==
ufo@^1.1.1:
version "1.1.1"
resolved "https://registry.yarnpkg.com/ufo/-/ufo-1.1.1.tgz#e70265e7152f3aba425bd013d150b2cdf4056d7c"
@ -13203,6 +13272,11 @@ yallist@^4.0.0:
resolved "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz"
integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==
yaml@2.2.2:
version "2.2.2"
resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.2.2.tgz#ec551ef37326e6d42872dad1970300f8eb83a073"
integrity sha512-CBKFWExMn46Foo4cldiChEzn7S7SRV+wqiluAb6xmueD/fGyRHIhX8m14vVGgeFWjN540nKCNVj6P21eQjgTuA==
yaml@^1.10.0, yaml@^1.10.2, yaml@^1.7.2:
version "1.10.2"
resolved "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz"