From 9857af17ded1e839f174db510c078febd5311f45 Mon Sep 17 00:00:00 2001 From: David Harder Date: Wed, 17 Jan 2024 15:23:36 -0600 Subject: [PATCH] Run Prettier --- .github/workflows/prettier.yml | 2 +- .github/workflows/spellcheck.yml | 6 +++--- docs/packaging/package.yml.md | 2 +- docs/packaging/packaging-practices.md | 2 +- docs/user/contributing/style.md | 12 ++++++------ docusaurus.config.js | 19 +++++++++---------- 6 files changed, 21 insertions(+), 22 deletions(-) diff --git a/.github/workflows/prettier.yml b/.github/workflows/prettier.yml index 66dc12b61..5b5a887bb 100644 --- a/.github/workflows/prettier.yml +++ b/.github/workflows/prettier.yml @@ -1,4 +1,4 @@ -name: 'Format with Prettier' +name: "Format with Prettier" on: pull_request: diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index 987f31a37..43e5a539b 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -1,4 +1,4 @@ -name: 'Spellcheck with cspell' +name: "Spellcheck with cspell" on: pull_request: @@ -15,5 +15,5 @@ jobs: inline: warning strict: false incremental_files_only: true - config: '.cspell.json' - verbose: false \ No newline at end of file + config: ".cspell.json" + verbose: false diff --git a/docs/packaging/package.yml.md b/docs/packaging/package.yml.md index 32cf24a3b..f91669c6f 100644 --- a/docs/packaging/package.yml.md +++ b/docs/packaging/package.yml.md @@ -63,7 +63,7 @@ Not all fields in `package.yml` are mandatory, but a small selection are. Below ### Optional, supported keys - Key Name | Type | Description | +| Key Name | Type | Description | | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **clang** | `bool` | Set to `yes` if this package benefits from being built with Clang. | | **extract** | `bool` | Set to `no` to disable automatic source extraction. | diff --git a/docs/packaging/packaging-practices.md b/docs/packaging/packaging-practices.md index 3442f6b2a..9fc2fdaf3 100644 --- a/docs/packaging/packaging-practices.md +++ b/docs/packaging/packaging-practices.md @@ -242,7 +242,7 @@ rundeps: ## Check dependencies Check dependencies are a special kind of build dependency reserved for automatic package testing by `solbuild`. Check dependencies should only be used during the `check` build phase. -When a package is part of an automatic build sequence, these dependencies will **not** be considered when determining build order. +When a package is part of an automatic build sequence, these dependencies will **not** be considered when determining build order. ### Example diff --git a/docs/user/contributing/style.md b/docs/user/contributing/style.md index 1308af092..7ee0a6111 100644 --- a/docs/user/contributing/style.md +++ b/docs/user/contributing/style.md @@ -38,12 +38,12 @@ This section is based on the [Red Hat supplementary style guide.](https://redhat Admonitions should draw the reader’s attention to certain information. Keep admonitions to a minimum, and avoid placing multiple admonitions close to one another. If multiple admonitions are necessary, restructure the information by moving the less-important statements into the flow of the main content. See the [Docusaurus documentation](https://docusaurus.io/docs/markdown-features/admonitions) to learn the correct syntax. -| Type | Description | -| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Note | Additional guidance or advice that improves product configuration, performance, or supportability | -| Important | Advisory information essential to the completion of a task or default configuration settings. Users must not disregard this information. | -| Warning/Danger | Information about potential system damage, data loss, or a support-related issue if the user disregards this admonition. If available, offer information to avoid the problem in the future or state where to find more information. | -| Tip | Recommendations, suggestions, and alternative methods that might not be obvious. Tips are not essential to using the product. | +| Type | Description | +| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Note | Additional guidance or advice that improves product configuration, performance, or supportability | +| Important | Advisory information essential to the completion of a task or default configuration settings. Users must not disregard this information. | +| Warning/Danger | Information about potential system damage, data loss, or a support-related issue if the user disregards this admonition. If available, offer information to avoid the problem in the future or state where to find more information. | +| Tip | Recommendations, suggestions, and alternative methods that might not be obvious. Tips are not essential to using the product. | ## Code blocks diff --git a/docusaurus.config.js b/docusaurus.config.js index d72e76ed3..3f06dc49b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -51,12 +51,12 @@ const config = { // Please change this to your repo. // Remove this to remove the "edit this page" links. //editUrl: "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/", - blogTitle: 'Solus DevLog', - blogDescription: 'The Solus Development (b)log!', - postsPerPage: 'ALL', - blogSidebarTitle: 'All posts', - blogSidebarCount: 'ALL', - path: 'devlog', + blogTitle: "Solus DevLog", + blogDescription: "The Solus Development (b)log!", + postsPerPage: "ALL", + blogSidebarTitle: "All posts", + blogSidebarCount: "ALL", + path: "devlog", }, theme: { customCss: require.resolve("./src/css/custom.css"), @@ -109,10 +109,9 @@ const config = { label: "Packaging", }, { - to: 'blog', - label: 'Dev Log', - position: 'left' - + to: "blog", + label: "Dev Log", + position: "left", }, ], },