From 995f5e8c87655f2e789cc4cf103e670a37a029c4 Mon Sep 17 00:00:00 2001 From: Eisen666 Date: Sun, 5 May 2024 22:16:41 +1000 Subject: [PATCH 1/3] update request help --- astro.config.mjs | 6 + package-lock.json | 144 +++++++++++++++++- package.json | 2 +- .../How-to-request-for-help.md | 88 +++++++++++ 4 files changed, 232 insertions(+), 8 deletions(-) create mode 100644 src/content/docs/Request-for-help/How-to-request-for-help.md diff --git a/astro.config.mjs b/astro.config.mjs index 444e1bf0..4647f73d 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -248,6 +248,12 @@ export default defineConfig({ }, ], }, + { + label: "Request for help", + autogenerate: { + directory: "Request-for-help", + }, + }, ], }), ], diff --git a/package-lock.json b/package-lock.json index 7a0d8828..334647ca 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11,8 +11,11 @@ "@astrojs/netlify": "^3.0.0", "@astrojs/starlight": "^0.9.0", "astro": "^3.0.7", - "prettier": "^3.0.3", + "prettier": "^3.2.5", "sharp": "^0.32.3" + }, + "devDependencies": { + "markdownlint": "^0.31.0" } }, "node_modules/@ampproject/remapping": { @@ -2028,6 +2031,18 @@ "once": "^1.4.0" } }, + "node_modules/entities": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-3.0.1.tgz", + "integrity": "sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==", + "dev": true, + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/es-module-lexer": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.3.0.tgz", @@ -2960,6 +2975,15 @@ "node": ">=6" } }, + "node_modules/linkify-it": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-4.0.1.tgz", + "integrity": "sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw==", + "dev": true, + "dependencies": { + "uc.micro": "^1.0.1" + } + }, "node_modules/load-yaml-file": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/load-yaml-file/-/load-yaml-file-0.2.0.tgz", @@ -3078,6 +3102,22 @@ "node": ">=0.10.0" } }, + "node_modules/markdown-it": { + "version": "13.0.1", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-13.0.1.tgz", + "integrity": "sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1", + "entities": "~3.0.1", + "linkify-it": "^4.0.1", + "mdurl": "^1.0.1", + "uc.micro": "^1.0.5" + }, + "bin": { + "markdown-it": "bin/markdown-it.js" + } + }, "node_modules/markdown-table": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-3.0.3.tgz", @@ -3087,6 +3127,28 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/markdownlint": { + "version": "0.31.1", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.31.1.tgz", + "integrity": "sha512-CKMR2hgcIBrYlIUccDCOvi966PZ0kJExDrUi1R+oF9PvqQmCrTqjOsgIvf2403OmJ+CWomuzDoylr6KbuMyvHA==", + "dev": true, + "dependencies": { + "markdown-it": "13.0.1", + "markdownlint-micromark": "0.1.7" + }, + "engines": { + "node": ">=16" + } + }, + "node_modules/markdownlint-micromark": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.7.tgz", + "integrity": "sha512-BbRPTC72fl5vlSKv37v/xIENSRDYL/7X/XoFzZ740FGEbs9vZerLrIkFRY0rv7slQKxDczToYuMmqQFN61fi4Q==", + "dev": true, + "engines": { + "node": ">=16" + } + }, "node_modules/mdast-util-definitions": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/mdast-util-definitions/-/mdast-util-definitions-5.1.2.tgz", @@ -3404,6 +3466,12 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/mdurl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", + "integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==", + "dev": true + }, "node_modules/merge-stream": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", @@ -4721,9 +4789,9 @@ } }, "node_modules/prettier": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.0.3.tgz", - "integrity": "sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==", + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz", + "integrity": "sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A==", "bin": { "prettier": "bin/prettier.cjs" }, @@ -5659,6 +5727,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/uc.micro": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", + "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", + "dev": true + }, "node_modules/undici": { "version": "5.23.0", "resolved": "https://registry.npmjs.org/undici/-/undici-5.23.0.tgz", @@ -7901,6 +7975,12 @@ "once": "^1.4.0" } }, + "entities": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-3.0.1.tgz", + "integrity": "sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==", + "dev": true + }, "es-module-lexer": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.3.0.tgz", @@ -8547,6 +8627,15 @@ "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz", "integrity": "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==" }, + "linkify-it": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-4.0.1.tgz", + "integrity": "sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw==", + "dev": true, + "requires": { + "uc.micro": "^1.0.1" + } + }, "load-yaml-file": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/load-yaml-file/-/load-yaml-file-0.2.0.tgz", @@ -8632,11 +8721,40 @@ "resolved": "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-1.1.1.tgz", "integrity": "sha512-WWC0ZuMzCyDHYCasEGs4IPvLyTGftYwh6wIEOULOF0HXcqZlhwRzrK0w2VUlxWA98xnvb/jszw4ZSkJ6ADpM6Q==" }, + "markdown-it": { + "version": "13.0.1", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-13.0.1.tgz", + "integrity": "sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q==", + "dev": true, + "requires": { + "argparse": "^2.0.1", + "entities": "~3.0.1", + "linkify-it": "^4.0.1", + "mdurl": "^1.0.1", + "uc.micro": "^1.0.5" + } + }, "markdown-table": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-3.0.3.tgz", "integrity": "sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==" }, + "markdownlint": { + "version": "0.31.1", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.31.1.tgz", + "integrity": "sha512-CKMR2hgcIBrYlIUccDCOvi966PZ0kJExDrUi1R+oF9PvqQmCrTqjOsgIvf2403OmJ+CWomuzDoylr6KbuMyvHA==", + "dev": true, + "requires": { + "markdown-it": "13.0.1", + "markdownlint-micromark": "0.1.7" + } + }, + "markdownlint-micromark": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.7.tgz", + "integrity": "sha512-BbRPTC72fl5vlSKv37v/xIENSRDYL/7X/XoFzZ740FGEbs9vZerLrIkFRY0rv7slQKxDczToYuMmqQFN61fi4Q==", + "dev": true + }, "mdast-util-definitions": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/mdast-util-definitions/-/mdast-util-definitions-5.1.2.tgz", @@ -8874,6 +8992,12 @@ "@types/mdast": "^3.0.0" } }, + "mdurl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", + "integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==", + "dev": true + }, "merge-stream": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", @@ -9710,9 +9834,9 @@ } }, "prettier": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.0.3.tgz", - "integrity": "sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==" + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz", + "integrity": "sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A==" }, "prismjs": { "version": "1.29.0", @@ -10340,6 +10464,12 @@ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.19.0.tgz", "integrity": "sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==" }, + "uc.micro": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", + "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", + "dev": true + }, "undici": { "version": "5.23.0", "resolved": "https://registry.npmjs.org/undici/-/undici-5.23.0.tgz", diff --git a/package.json b/package.json index e730335b..9c20316e 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ "@astrojs/netlify": "^3.0.0", "@astrojs/starlight": "^0.9.0", "astro": "^3.0.7", - "prettier": "^3.0.3", + "prettier": "^3.2.5", "sharp": "^0.32.3" }, "devDependencies": { diff --git a/src/content/docs/Request-for-help/How-to-request-for-help.md b/src/content/docs/Request-for-help/How-to-request-for-help.md new file mode 100644 index 00000000..d1feafd0 --- /dev/null +++ b/src/content/docs/Request-for-help/How-to-request-for-help.md @@ -0,0 +1,88 @@ +--- +title: How to Request Help When Encountering an Issue +--- + +# How to Request Help When Encountering an Issue + +When you encounter an error during a task, it's essential to seek assistance promptly to minimize +delays and ensure smooth project progress. Follow these steps to submit a request for help on your +team channel: + +## 1. Identify Your Team Channel + +Each project team has a dedicated channel for communication. For instance, if you're part of the +OnTrack Project Team, you should post your message on the OnTrack Channel. + +## 2. Craft Your Message + +Compose a message in the team channel that provides essential details about the issue you're facing. +Use the following standard format: + +**Content you need to provide:** + +- **Backlog:** + Provide the task name from the backlog. + +- **Component:** + Specify the component or module you are working on. + +- **Repository:** + Include the link with problematic changes. + +- **Related Files:** + List the files you are working on or have modified, and include screenshots. + +- **Issue Description:** + Provide a concise description of the issue you are facing, and include a screenshot if applicable. + +- **Error Messages:** + Include any error messages or codes here, along with screenshots. + +- **Steps to Reproduce:** + List the steps you took that led to the issue, and include screenshots. + +- **What You Have Tried:** + Describe what you have attempted so far to resolve the issue, including any troubleshooting steps. + +- **Expected Outcome:** + Describe what you expected to happen. + +## 3. Example Message + +```markdown +Subject: Urgent: Request for Assistance - Issue with [Task Name] + +Backlog: [Task Name from Backlog] Component: [Component/Module Name] Repository: [Link to Repository +with Problematic Changes] + +Related Files: + +- [File 1] +- [File 2] +- [Screenshot of Related Files] + +Issue Description: I encountered an issue while attempting to [describe the task]. Despite following +the outlined steps, [describe the problem briefly]. Please refer to the attached screenshot for more +clarity. + +Error Messages: + +- [Error Message 1] +- [Error Message 2] +- [Screenshot of Error Messages] + +Steps to Reproduce: + +1. [Step 1] +2. [Step 2] +3. [Step 3] [Include Screenshots of Steps] + +What You Have Tried: I have attempted the following: + +- [Troubleshooting Step 1] +- [Troubleshooting Step 2] + +Expected Outcome: [Describe what you expected to happen.] + +Any assistance in resolving this issue would be greatly appreciated. Thank you. +``` From 7c1b4c9cf4c209849675dfc7e26c533667f0985f Mon Sep 17 00:00:00 2001 From: Eisen666 Date: Sun, 5 May 2024 23:37:20 +1000 Subject: [PATCH 2/3] Update How-to-request-for-help.md --- .../Request-for-help/How-to-request-for-help.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/content/docs/Request-for-help/How-to-request-for-help.md b/src/content/docs/Request-for-help/How-to-request-for-help.md index d1feafd0..5e402001 100644 --- a/src/content/docs/Request-for-help/How-to-request-for-help.md +++ b/src/content/docs/Request-for-help/How-to-request-for-help.md @@ -2,11 +2,10 @@ title: How to Request Help When Encountering an Issue --- -# How to Request Help When Encountering an Issue - When you encounter an error during a task, it's essential to seek assistance promptly to minimize -delays and ensure smooth project progress. Follow these steps to submit a request for help on your -team channel: +delays and ensure smooth project progress. If you submit a request for help, it will be better to +provide clear and detailed information to streamline the troubleshooting process. Follow these steps +to submit a request for help on your team channel: ## 1. Identify Your Team Channel @@ -21,7 +20,7 @@ Use the following standard format: **Content you need to provide:** - **Backlog:** - Provide the task name from the backlog. + Provide the Backlog name and task name. - **Component:** Specify the component or module you are working on. @@ -50,10 +49,11 @@ Use the following standard format: ## 3. Example Message ```markdown -Subject: Urgent: Request for Assistance - Issue with [Task Name] +Subject: Request for Assistance - Issue with [Task Name] -Backlog: [Task Name from Backlog] Component: [Component/Module Name] Repository: [Link to Repository -with Problematic Changes] +Backlog: [Backlog Name and Task Name] +Component: [Component/Module Name] +Repository: [Link to Repository with Problematic Changes] Related Files: From 98085447a9e07fdd5bae748e3dc8685c080945e2 Mon Sep 17 00:00:00 2001 From: Eisen666 Date: Mon, 6 May 2024 00:35:11 +1000 Subject: [PATCH 3/3] Update How-to-request-for-help.md --- src/content/docs/Request-for-help/How-to-request-for-help.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/content/docs/Request-for-help/How-to-request-for-help.md b/src/content/docs/Request-for-help/How-to-request-for-help.md index 5e402001..abe2f47f 100644 --- a/src/content/docs/Request-for-help/How-to-request-for-help.md +++ b/src/content/docs/Request-for-help/How-to-request-for-help.md @@ -51,9 +51,8 @@ Use the following standard format: ```markdown Subject: Request for Assistance - Issue with [Task Name] -Backlog: [Backlog Name and Task Name] -Component: [Component/Module Name] -Repository: [Link to Repository with Problematic Changes] +Backlog: [Backlog Name and Task Name] Component: [Component/Module Name] Repository: [Link to +Repository with Problematic Changes] Related Files: