From 3cc2aa5c3244fbedea63cde6a0d0e827085cd80c Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 25 Feb 2025 10:37:58 -0500 Subject: [PATCH] [CI] Update packages and run checks and fixes Signed-off-by: Patrice Chalin --- analyses/0010-etcd/etcd-analysis.md | 4 ++-- .../0013-litmuschaos/litmuschaos-analysis.md | 21 ++++++++++--------- .../litmuschaos-implementation.md | 2 +- docs/analysis/howto.md | 4 ++-- docs/analysis/templates/analysis.md | 20 +++++++++--------- docs/analytics.md | 14 ++++++------- package.json | 16 +++++++------- 7 files changed, 42 insertions(+), 39 deletions(-) diff --git a/analyses/0010-etcd/etcd-analysis.md b/analyses/0010-etcd/etcd-analysis.md index 22efb6f..6c3d20c 100644 --- a/analyses/0010-etcd/etcd-analysis.md +++ b/analyses/0010-etcd/etcd-analysis.md @@ -313,8 +313,8 @@ For example: - [installation check][install-check]: contains "sanity check", a term designated "Strongly Consider Replacing" by the [Inclusive Naming Initiative][inclusive-naming]. -- There is some use of language like "easy", "simple", and "just [take - an action]"; for example, "Creating a user is as easy as" in +- There is some use of language like "easy", "simple", and "just [take an + action]"; for example, "Creating a user is as easy as" in [Role-based access control](https://etcd.io/docs/v3.5/op-guide/authentication/rbac/). ## Recommendations diff --git a/analyses/0013-litmuschaos/litmuschaos-analysis.md b/analyses/0013-litmuschaos/litmuschaos-analysis.md index 462f298..99cdc86 100644 --- a/analyses/0013-litmuschaos/litmuschaos-analysis.md +++ b/analyses/0013-litmuschaos/litmuschaos-analysis.md @@ -30,8 +30,9 @@ This document was written to analyze the current state of LitmusChaos documentation. It aims to provide project leaders with an informed understanding of potential problems in current project documentation. A second [implementation] document outlines an actionable plan for improvement. A third -document is an [issues list] of issues to be added to the project documentation repository. -These issues can be taken up by contributors to improve the documentation. +document is an [issues list] of issues to be added to the project documentation +repository. These issues can be taken up by contributors to improve the +documentation. This document: @@ -172,9 +173,9 @@ installation, configuration, and running a "first-time" experiment. - Formatting and organization of the instructions is inconsistent. - Some minor functionality does not have complete step-by-step instructions. For example, a link in the instructions to connect an external delegate in - _Schedule a chaos scenario_ - point to the `litmusctl` reference. While relevant, this is not the same as - explicit instructions for connecting to a delegate. + _Schedule a chaos scenario_ point to the `litmusctl` reference. While + relevant, this is not the same as explicit instructions for connecting to a + delegate. @@ -604,12 +605,12 @@ websites: -| Site | Repository | Tool or Stack | -|-----------| -------------------------------------------------------- | ------------------------ | -| [Project website](https://litmuschaos.io/) | https://github.com/litmuschaos/litmus-website-2 | React/Next/Tailwind/SCSS | +| Site | Repository | Tool or Stack | +| ----------------------------------------------------- | -------------------------------------------------------- | ------------------------ | +| [Project website](https://litmuschaos.io/) | https://github.com/litmuschaos/litmus-website-2 | React/Next/Tailwind/SCSS | | [Documentation website](https://docs.litmuschaos.io/) | https://github.com/litmuschaos/litmus-docs/ | Docusaurus/Netlify | -| Tutorials | https://github.com/litmuschaos/tutorials | Google Codelab? | -| [APIs][api-site] | https://github.com/litmuschaos/litmus/tree/master/mkdocs | MkDocs | +| Tutorials | https://github.com/litmuschaos/tutorials | Google Codelab? | +| [APIs][api-site] | https://github.com/litmuschaos/litmus/tree/master/mkdocs | MkDocs | diff --git a/analyses/0013-litmuschaos/litmuschaos-implementation.md b/analyses/0013-litmuschaos/litmuschaos-implementation.md index 6510cbd..1c458cc 100644 --- a/analyses/0013-litmuschaos/litmuschaos-implementation.md +++ b/analyses/0013-litmuschaos/litmuschaos-implementation.md @@ -133,7 +133,7 @@ There are at least four "getting started" links on the website. | _Get Started_ button | [Doc landing page](https://docs.litmuschaos.io/) | [ChaosCenter installation](https://docs.litmuschaos.io/docs/getting-started/installation) | | _Getting Started_ link | [Doc landing page](https://docs.litmuschaos.io/) | [What is Litmus?](https://docs.litmuschaos.io/docs/introduction/what-is-litmus) | | _Getting Started_ TOC entry | [Doc page](https://docs.litmuschaos.io/docs/) left-side menu | [ChaosCenter installation](https://docs.litmuschaos.io/docs/getting-started/installation) | -| _Getting started_ tutorial | Tutorial site | [Getting started tutorial](https://litmuschaos.github.io/tutorials/tutorial-getting-started/index.html#0) | +| _Getting started_ tutorial | Tutorial site | [Getting started tutorial](https://litmuschaos.github.io/tutorials/tutorial-getting-started/index.html#0) | diff --git a/docs/analysis/howto.md b/docs/analysis/howto.md index d17bafb..40b6102 100644 --- a/docs/analysis/howto.md +++ b/docs/analysis/howto.md @@ -12,8 +12,8 @@ The goals of a CNCF technical documentation analysis are to: - Examine the current project technical documentation and website against the CNCF's analysis [criteria]. -- Compare the documentation against the current or proposed [project - maturity level]. +- Compare the documentation against the current or proposed [project maturity + level]. - Recommend a program of key documentation improvements with the largest return on investment. These improvements are documented as _recommendations_ in the analysis document, and expanded in a companion diff --git a/docs/analysis/templates/analysis.md b/docs/analysis/templates/analysis.md index a7c1b2d..b975ae5 100644 --- a/docs/analysis/templates/analysis.md +++ b/docs/analysis/templates/analysis.md @@ -46,8 +46,8 @@ This document was written to analyze the current state of _PROJECT_ documentation. It aims to provide project leaders with an informed understanding of potential problems in current project documentation. A second [impementation] document, , outlines an actionable plan for improvement. A third document is an -[issues list] of issues to be added to the project documentation repository. These -issues can be taken up by contributors to improve the documentation. +[issues list] of issues to be added to the project documentation repository. +These issues can be taken up by contributors to improve the documentation. This document: @@ -61,23 +61,23 @@ The documentation discussed here includes the entire contents of the website, the technical documentation, and documentation for contributors and users on the _PROJECT_ GitHub repository. -The _PROJECT_ website and documentation are written in [Markdown, -ReStructured Text, other] and are compiled using the [Hugo, Docusaurus, -Sphynx, other] static site generator with the [Docsy, other] theme and served from -[the Netlify platform, other]. The site's code is stored on the _PROJECT_ GitHub -repo. +The _PROJECT_ website and documentation are written in [Markdown, ReStructured +Text, other] and are compiled using the [Hugo, Docusaurus, Sphynx, other] static +site generator with the [Docsy, other] theme and served from [the Netlify +platform, other]. The site's code is stored on the _PROJECT_ GitHub repo. #### In scope - Website: _PROJECT-WEBSITE_ - Documentation: _PROJECT-DOC-URL_ - Website repo: _PROJECT-DOC-REPO_ -- _[Other; might include a demo server, governance site, or other relevant repositories]_ +- _[Other; might include a demo server, governance site, or other relevant + repositories]_ #### Out of scope -- Other _PROJECT_ repos: _[In general, do not include sub-projects or - related "ecosystem" projects]_ +- Other _PROJECT_ repos: _[In general, do not include sub-projects or related + "ecosystem" projects]_ ### How this document is organized diff --git a/docs/analytics.md b/docs/analytics.md index 3836b97..bd85d11 100644 --- a/docs/analytics.md +++ b/docs/analytics.md @@ -33,8 +33,8 @@ process below. Adapt it to your needs. Useful resources to consider include: In preparation for the migration, follow these steps: 1. **Create an issue** over your project's website with the title "Migrate to - Google Analytics 4 (GA4)", and link to [Issue #108][]. For example, see the issues - opened for the pilot projects listed in #108. + Google Analytics 4 (GA4)", and link to [Issue #108][]. For example, see the + issues opened for the pilot projects listed in #108. 2. Determine which **analytics library** your project's website is using. @@ -69,8 +69,8 @@ Follow these steps: How you switch will depend on the static-site generation tooling you use. For details, see [Stage 2][]. If you know how to switch and it is easy to do - so, then switch your project to [gtag.js][], otherwise defer the switch to [stage - 2][]. + so, then switch your project to [gtag.js][], otherwise defer the switch to + [stage 2][]. 2. **Open the analytics console** of your project's UA property by visiting [analytics.google.com](https://analytics.google.com). @@ -179,9 +179,9 @@ code (such as custom Hugo partials) to enable GA4, consider removing the custom code in favor of the native support provided by your site-generator tooling. For example, for [Docsy][]-based websites, all you need to do is provide your -project's GA4 measurement ID. Details are provided in [Adding Analytics][]. Of course, -this may require you to upgrade the version of [Docsy][] and/or Hugo that your project -is using. +project's GA4 measurement ID. Details are provided in [Adding Analytics][]. Of +course, this may require you to upgrade the version of [Docsy][] and/or Hugo +that your project is using. [add gtag.js to your site]: https://developers.google.com/analytics/devguides/collection/gtagjs/ diff --git a/package.json b/package.json index 7808dc6..746c11f 100644 --- a/package.json +++ b/package.json @@ -23,19 +23,21 @@ "fix:format": "npm run _check:format -- --write", "fix": "npm run seq -- $(npm -s run _list:fix:*)", "seq": "bash -c 'for cmd in \"$@\"; do npm run $cmd || exit 1; done' - ", - "test": "npm run check" + "test": "npm run check", + "update:pkgs": "npx npm-check-updates -u" }, "author": "CNCF", "license": "CC-BY-4.0", "devDependencies": { - "cspell": "^8.8.4", - "markdown-link-check": "^3.12.2", - "markdownlint": "^0.34.0", - "markdownlint-cli": "^0.41.0", - "prettier": "^3.3.2" + "cspell": "^8.17.5", + "markdown-link-check": "^3.13.6", + "markdownlint": "^0.37.4", + "markdownlint-cli": "^0.44.0", + "npm-check-updates": "^17.1.15", + "prettier": "^3.5.2" }, "private": true, - "spelling": "cSpell:ignore ACMR loglevel -", + "spelling": "cSpell:ignore ACMR loglevel pkgs -", "prettier": { "proseWrap": "always", "singleQuote": true