From 9ddca0249fc42f771c9a9e239b2dd48ee09d3195 Mon Sep 17 00:00:00 2001 From: Simon Graband Date: Tue, 10 Dec 2024 16:05:50 +0100 Subject: [PATCH] Updating publishing guide and set markdown formatter (#14553) - Set formatter for markdown files - Format all markdown files - Update publishing guide Signed-off-by: Simon Graband --- .theia/settings.json | 10 +- .vscode/extensions.json | 3 +- .vscode/settings.json | 10 +- CODE_OF_CONDUCT.md | 6 +- CONTRIBUTING.md | 4 +- NOTICE.md | 128 ++++--- README.md | 1 + dev-packages/application-manager/README.md | 3 +- dev-packages/application-package/README.md | 3 +- dev-packages/cli/README.md | 15 +- dev-packages/localization-manager/README.md | 4 +- dev-packages/native-webpack-plugin/README.md | 3 +- dev-packages/ovsx-client/README.md | 3 +- dev-packages/private-eslint-plugin/README.md | 18 +- dev-packages/private-ext-scripts/README.md | 4 +- dev-packages/request/README.md | 3 +- doc/Developing.md | 236 +++++++------ doc/Migration.md | 6 +- doc/Publishing.md | 327 ++++++++++++------ doc/Testing.md | 23 +- doc/api-management.md | 7 +- doc/api-testing.md | 3 + doc/changelogs/CHANGELOG-2019.md | 44 +-- doc/changelogs/CHANGELOG-2020.md | 34 +- doc/changelogs/CHANGELOG-2021.md | 2 +- doc/changelogs/CHANGELOG-2022.md | 12 +- doc/code-organization.md | 2 +- doc/coding-guidelines.md | 96 ++++- doc/pull-requests.md | 27 +- doc/runtime-policy.md | 6 +- doc/vscode-usage.md | 6 +- examples/api-provider-sample/README.md | 6 +- examples/api-samples/README.md | 4 +- examples/playwright/README.md | 2 +- package.json | 1 + packages/ai-chat-ui/README.md | 3 +- packages/ai-chat/README.md | 3 +- packages/ai-code-completion/README.md | 3 +- packages/ai-core/README.md | 3 +- packages/ai-history/README.md | 3 +- packages/ai-hugging-face/README.md | 2 +- packages/ai-llamafile/README.md | 14 +- packages/ai-openai/README.md | 3 +- packages/ai-terminal/README.md | 10 +- packages/ai-workspace-agent/README.md | 3 +- packages/bulk-edit/README.md | 3 +- packages/callhierarchy/README.md | 3 +- packages/collaboration/README.md | 3 +- packages/console/README.md | 3 +- packages/core/README.md | 82 ++--- packages/core/README_TEMPLATE.md | 10 +- packages/debug/README.md | 21 +- packages/dev-container/README.md | 7 +- packages/editor-preview/README.md | 16 +- packages/editor/README.md | 3 +- packages/electron/README.md | 11 +- packages/electron/README_TEMPLATE.md | 5 +- packages/external-terminal/README.md | 6 +- packages/file-search/README.md | 3 +- packages/filesystem/README.md | 3 +- .../filesystem/src/common/download/README.md | 12 +- packages/getting-started/README.md | 4 +- packages/git/README.md | 4 +- packages/keymaps/README.md | 9 +- packages/markers/README.md | 4 +- packages/memory-inspector/README.md | 4 +- packages/messages/README.md | 3 +- packages/metrics/README.md | 3 +- packages/mini-browser/README.md | 3 +- packages/monaco/README.md | 33 +- packages/navigator/README.md | 3 +- packages/notebook/README.md | 3 +- packages/outline-view/README.md | 3 +- packages/output/README.md | 3 +- packages/plugin-dev/README.md | 4 +- packages/plugin-ext-headless/README.md | 3 +- packages/plugin-ext-vscode/README.md | 4 +- packages/plugin-ext/README.md | 5 +- packages/plugin-metrics/README.md | 7 +- packages/plugin/README.md | 26 +- packages/preferences/README.md | 23 +- packages/preview/README.md | 3 +- packages/process/README.md | 3 +- packages/property-view/README.md | 5 +- packages/remote/README.md | 2 +- packages/scm-extra/README.md | 4 +- packages/scm/README.md | 3 +- packages/search-in-workspace/README.md | 4 +- packages/task/README.md | 13 +- packages/terminal/README.md | 3 +- packages/timeline/README.md | 3 +- packages/toolbar/README.md | 5 +- packages/typehierarchy/README.md | 3 +- packages/userstorage/README.md | 7 +- packages/variable-resolver/README.md | 9 +- packages/vsx-registry/README.md | 3 +- packages/workspace/README.md | 3 +- .../sample-namespace/plugin-gotd/README.md | 4 +- scripts/performance/README.md | 46 +-- 99 files changed, 961 insertions(+), 613 deletions(-) diff --git a/.theia/settings.json b/.theia/settings.json index 23199246981cf..d6872327e715c 100644 --- a/.theia/settings.json +++ b/.theia/settings.json @@ -11,5 +11,13 @@ "editor.tabSize": 2 }, "typescript.tsdk": "node_modules/typescript/lib", - "clang-format.language.typescript.enable": false + "clang-format.language.typescript.enable": false, + "[markdown]": { + "editor.defaultFormatter": "davidanson.vscode-markdownlint" + }, + "markdownlint.config": { + "MD032": false, // don't require blank line around lists + "MD033": false, // allow inline html + "MD041": false // don't require h1 in first line + }, } diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 517d760915049..4f803f4512200 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -3,7 +3,8 @@ // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp // List of extensions which should be recommended for users of this workspace. "recommendations": [ - "dbaeumer.vscode-eslint" + "dbaeumer.vscode-eslint", + "DavidAnson.vscode-markdownlint" ], // List of extensions recommended by VS Code that should not be recommended for users of this workspace. "unwantedRecommendations": [] diff --git a/.vscode/settings.json b/.vscode/settings.json index 8166ed2cb0656..a07b759be7e50 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -51,6 +51,9 @@ "editor.tabSize": 2, "editor.defaultFormatter": "vscode.json-language-features", }, + "[markdown]": { + "editor.defaultFormatter": "DavidAnson.vscode-markdownlint" + }, "typescript.tsdk": "node_modules/typescript/lib", "files.insertFinalNewline": true, "clang-format.language.typescript.enable": false, @@ -63,5 +66,10 @@ "editor.defaultFormatter": "vscode.typescript-language-features", "typescript.preferences.quoteStyle": "single", "editor.tabSize": 4, - } + }, + "markdownlint.config": { + "MD032": false, // don't require blank line around lists + "MD033": false, // allow inline html + "MD041": false // don't require h1 in first line + }, } diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f5254ea3e68ce..88ca1cbd71529 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -43,15 +43,15 @@ This Code of Conduct applies within all project spaces, and it also applies when ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at codeofconduct@eclipse.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at . All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at -For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq +For answers to common questions about this code of conduct, see