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 <[email protected]>
eclipse-theia · Dec 10, 2024 · 9ddca02 · 9ddca02
1 parent fb09901
commit 9ddca02
Show file tree

Hide file tree

Showing 99 changed files with 961 additions and 613 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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 [email protected]. 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 <[email protected]>. 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 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
 
-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 <https://www.contributor-covenant.org/faq>
 
 <div id="theia-logo" align="left">
     <br />

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -55,7 +55,7 @@ We follow the coding guidelines described
 Before your contribution can be accepted by the project team contributors must
 electronically sign the Eclipse Contributor Agreement (ECA).
 
-* https://www.eclipse.org/legal/ECA.php
+* <https://www.eclipse.org/legal/ECA.php>
 
 Commits that are provided by non-committers must have a Signed-off-by field in
 the footer indicating that the author is aware of the terms by which the
@@ -64,7 +64,7 @@ additionally have an Eclipse Foundation account and must have a signed Eclipse
 Contributor Agreement (ECA) on file.
 
 For more information, please see the Eclipse Committer Handbook:
-https://www.eclipse.org/projects/handbook/#resources-commit
+<https://www.eclipse.org/projects/handbook/#resources-commit>
 
 ## Sign your work
 

diff --git a/NOTICE.md b/NOTICE.md
@@ -2,7 +2,7 @@
 
 This content is produced and maintained by the Eclipse Theia project.
 
-* Project home: https://projects.eclipse.org/projects/ecd.theia
+* Project home: <https://projects.eclipse.org/projects/ecd.theia>
 
 ## Trademarks
 
@@ -18,29 +18,29 @@ source code repository logs.
 
 This program and the accompanying materials are made available under the terms
 of the Eclipse Public License v. 2.0 which is available at
-https://www.eclipse.org/legal/epl-2.0. This Source Code may also be made
+<https://www.eclipse.org/legal/epl-2.0>. This Source Code may also be made
 available under the following Secondary Licenses when the conditions for such
 availability set forth in the Eclipse Public License v. 2.0 are satisfied:
 (secondary) GPL-2.0 with Classpath-exception-2.0 which is available at GNU
 General Public License v2.0 w/Classpath exception',
-'https://www.gnu.org/software/classpath/license.html.
+'<https://www.gnu.org/software/classpath/license.html>.
 
 SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 
 ## Source Code
 
 The project maintains the following source code repositories:
 
-* https://github.com/eclipse-theia/theia
-* https://github.com/eclipse/theia-generator-plugin
-* https://github.com/eclipse/theia-yeoman-plugin
-* https://github.com/eclipse/theia-plugin-packager
-* https://github.com/eclipse-theia/theia-cpp-extensions
-* https://github.com/eclipse/theia-python-extension
-* https://github.com/eclipse/theia-java-extension
-* https://github.com/eclipse-theia/theia-example
-* https://github.com/eclipse-theia/cryptodetector
-* https://github.com/eclipse-theia/generator-theia-extension
+* <https://github.com/eclipse-theia/theia>
+* <https://github.com/eclipse/theia-generator-plugin>
+* <https://github.com/eclipse/theia-yeoman-plugin>
+* <https://github.com/eclipse/theia-plugin-packager>
+* <https://github.com/eclipse-theia/theia-cpp-extensions>
+* <https://github.com/eclipse/theia-python-extension>
+* <https://github.com/eclipse/theia-java-extension>
+* <https://github.com/eclipse-theia/theia-example>
+* <https://github.com/eclipse-theia/cryptodetector>
+* <https://github.com/eclipse-theia/generator-theia-extension>
 
 ## Third-party Content
 
@@ -49,8 +49,8 @@ This project leverages the following third party content.
 chalk (2.4.1)
 
 * License: MIT
-* Project: https://github.com/chalk/chalk
-* Source: https://github.com/chalk/chalk
+* Project: <https://github.com/chalk/chalk>
+* Source: <https://github.com/chalk/chalk>
 
 code copied from project cortex-debug (0.1.21)
 
@@ -63,8 +63,8 @@ Code copied from project Microsoft/vscode (1.31.0)
 Code copied from project Microsoft/vscode (1.32.3)
 
 * License: MIT
-* Project: https://code.visualstudio.com/
-* Source: https://github.com/Microsoft/vscode
+* Project: <https://code.visualstudio.com/>
+* Source: <https://github.com/Microsoft/vscode>
 
 Code copied from project Microsoft/vscode (1.32.3)
 
@@ -108,7 +108,6 @@ code copied from project vscode (1.34.0)
 
 code copied from project vscode (1.36.1)
 
-
 code copied from project vscode (1.36.1)
 
 * License: MIT
@@ -178,14 +177,14 @@ [email protected] (2.0.14)
    AND BSD-3-Clause AND ISC AND X11 AND Public-Domain AND (GPL-2.0 OR MIT) AND
    Unlicense AND IJG AND ICU AND UNICODE-TOU AND NTP AND (MIT OR BSD-3-Clause)
    AND Libpng AND MPL-2.0 AND LGPL-2.1+
-* Project: https://github.com/electron/electron
-* Source: https://github.com/electron/electron/releases/tag/v2.0.14
+* Project: <https://github.com/electron/electron>
+* Source: <https://github.com/electron/electron/releases/tag/v2.0.14>
 
 getmac (1.4.6)
 
 * License: MIT
-* Project: https://github.com/bevry/getmac
-* Source: https://github.com/bevry/getmac
+* Project: <https://github.com/bevry/getmac>
+* Source: <https://github.com/bevry/getmac>
 
 GH-3397: Implemented the HTTP-based authentication for Git in Electron. (n/a)
 
@@ -194,15 +193,15 @@ GH-3397: Implemented the HTTP-based authentication for Git in Electron. (n/a)
 glob promise (3.4.0)
 
 * License: ISC
-* Project: https://github.com/ahmadnassri/glob-promise
-* Source: https://github.com/ahmadnassri/glob-promise
+* Project: <https://github.com/ahmadnassri/glob-promise>
+* Source: <https://github.com/ahmadnassri/glob-promise>
 
 Icon configure-inverse.svg (n/a)
 
 * License: MIT
-* Project: https://github.com/Microsoft/vscode
+* Project: <https://github.com/Microsoft/vscode>
 * Source:
-   https://github.com/Microsoft/vscode/blob/master/src/vs/workbench/contrib/tasks/common/media/configure-inverse.svg#L1
+   <https://github.com/Microsoft/vscode/blob/master/src/vs/workbench/contrib/tasks/common/media/configure-inverse.svg#L1>
 
 Icons copied from microsoft/vscode-icons version:
 b73945c70f1117c4e65939dd3e10bdd623cb4ef3 (n/a)
@@ -216,9 +215,9 @@ inversify (5.0.1)
 jschardet (1.6.0)
 
 * License: (LGPL-2.1 OR LGPL-2.1+) AND (MIT OR GPL-2.0)
-* Project: https://www.npmjs.com/package/jschardet
+* Project: <https://www.npmjs.com/package/jschardet>
 * Source:
-   https://github.com/aadsm/jschardet/tree/28152dd8db5904dc2cf9aa12ef4f8783f713e79a
+   <https://github.com/aadsm/jschardet/tree/28152dd8db5904dc2cf9aa12ef4f8783f713e79a>
 
 jschardet (2.1.1)
 
@@ -243,20 +242,20 @@ long.js (3.2.0)
 micromatch (3.1.10)
 
 * License: MIT
-* Project: https://github.com/micromatch/micromatch
-* Source: https://github.com/micromatch/micromatch
+* Project: <https://github.com/micromatch/micromatch>
+* Source: <https://github.com/micromatch/micromatch>
 
 monaco-typescript (2.3.0)
 
 * License: MIT
-* Project: https://github.com/Microsoft/monaco-typescript
-* Source: https://github.com/Microsoft/monaco-typescript.git
+* Project: <https://github.com/Microsoft/monaco-typescript>
+* Source: <https://github.com/Microsoft/monaco-typescript.git>
 
 native-keymap (1.2.5)
 
 * License: BSD-3-Clause AND MIT
-* Project: https://github.com/Microsoft/node-native-keymap
-* Source: https://github.com/Microsoft/node-native-keymap
+* Project: <https://github.com/Microsoft/node-native-keymap>
+* Source: <https://github.com/Microsoft/node-native-keymap>
 
 node-oniguruma (n/a)
 
@@ -272,24 +271,23 @@ node.js dependencies for Theia (n/a)
 
 Preference code copied from vscode (n/a)
 
-
 ps-list (5.0.1)
 
 * License: MIT
-* Project: https://github.com/sindresorhus/ps-list
-* Source: https://github.com/sindresorhus/ps-list
+* Project: <https://github.com/sindresorhus/ps-list>
+* Source: <https://github.com/sindresorhus/ps-list>
 
 react-perfect-scrollbar:1.5.3 (1.5.3)
 
 * License: MIT
-* Project: https://github.com/goldenyz/react-perfect-scrollbar
-* Source: https://github.com/goldenyz/react-perfect-scrollbar
+* Project: <https://github.com/goldenyz/react-perfect-scrollbar>
+* Source: <https://github.com/goldenyz/react-perfect-scrollbar>
 
 read-pkg (4.0.1)
 
 * License: MIT
-* Project: https://github.com/sindresorhus/read-pkg
-* Source: https://github.com/sindresorhus/read-pkg
+* Project: <https://github.com/sindresorhus/read-pkg>
+* Source: <https://github.com/sindresorhus/read-pkg>
 
 regular expressions and helper function copied from microsoft/vscode (1.33.1)
 
@@ -298,8 +296,8 @@ regular expressions and helper function copied from microsoft/vscode (1.33.1)
 requestretry (3.1.0)
 
 * License: MIT
-* Project: https://github.com/FGRibreau/node-request-retry
-* Source: https://github.com/FGRibreau/node-request-retry
+* Project: <https://github.com/FGRibreau/node-request-retry>
+* Source: <https://github.com/FGRibreau/node-request-retry>
 
 rimraf (2.6.2)
 
@@ -326,8 +324,8 @@ theia-cpp-extension npm node (n/a)
 tslint (5.10.0)
 
 * License: Apache-2.0 AND MIT
-* Project: http://palantir.github.io/tslint/
-* Source: https://github.com/palantir/tslint
+* Project: <http://palantir.github.io/tslint/>
+* Source: <https://github.com/palantir/tslint>
 
 typefox/monaco-language-client (0.5.0)
 
@@ -336,16 +334,16 @@ typefox/monaco-language-client (0.5.0)
 typescript-formatter (7.2.2)
 
 * License: MIT
-* Project: https://github.com/vvakame/typescript-formatter
-* Source: https://github.com/vvakame/typescript-formatter
+* Project: <https://github.com/vvakame/typescript-formatter>
+* Source: <https://github.com/vvakame/typescript-formatter>
 
 VS Code (1.33.0)
 
 * License: MIT
 
 VS Code built-in extensions (1.30.1)
 
-* License: Apache-2.0 AND MIT AND Unicode-DFS-2016 AND CC-BY-4.0 AND W3C 
+* License: Apache-2.0 AND MIT AND Unicode-DFS-2016 AND CC-BY-4.0 AND W3C
 
 vscode (1.26.0)
 
@@ -382,14 +380,14 @@ vscode-java-debug (0.15.0)
 webdriverio (n/a)
 
 * License: MIT
-* Project: http://webdriver.io/
-* Source: https://github.com/webdriverio/webdriverio.git
+* Project: <http://webdriver.io/>
+* Source: <https://github.com/webdriverio/webdriverio.git>
 
 when (3.7.8)
 
 * License: MIT
-* Project: https://github.com/cujojs/when
-* Source: https://github.com/cujojs/when
+* Project: <https://github.com/cujojs/when>
+* Source: <https://github.com/cujojs/when>
 
 wjordan/browser-path SHA6719d19077b1454bff8b802f9be79cb1b69ebe7e (n/a)
 
@@ -406,8 +404,8 @@ xterm-addon-search (0.5.0)
 xterm.js (3.9.1)
 
 * License: MIT
-* Project: https://xtermjs.org/
-* Source: https://github.com/xtermjs/xterm.js
+* Project: <https://xtermjs.org/>
+* Source: <https://github.com/xtermjs/xterm.js>
 
 xterm.js (4.4)
 
@@ -416,32 +414,32 @@ xterm.js (4.4)
 yargs (12.0.1)
 
 * License: MIT
-* Project: http://yargs.js.org/
-* Source: https://github.com/yargs/yargs
+* Project: <http://yargs.js.org/>
+* Source: <https://github.com/yargs/yargs>
 
 yeoman environment (2.3.0)
 
 * License: BSD-2-Clause AND BSD-3-Clause
-* Project: https://github.com/yeoman/environment
-* Source: https://github.com/yeoman/environment
+* Project: <https://github.com/yeoman/environment>
+* Source: <https://github.com/yeoman/environment>
 
 yeoman generator (3.0.0)
 
 * License: BSD-2-Clause AND BSD-3-Clause
-* Project: http://yeoman.io
-* Source: https://github.com/yeoman/generator
+* Project: <http://yeoman.io>
+* Source: <https://github.com/yeoman/generator>
 
 yeoman-generator (2.0)
 
 * License: BSD-2-Clause
-* Project: http://yeoman.io/
-* Source: https://github.com/yeoman/generator
+* Project: <http://yeoman.io/>
+* Source: <https://github.com/yeoman/generator>
 
 yosay (2.0.2)
 
 * License: BSD-2-Clause
-* Project: https://github.com/yeoman/yosay
-* Source: https://github.com/yeoman/yosay
+* Project: <https://github.com/yeoman/yosay>
+* Source: <https://github.com/yeoman/yosay>
 
 ## Cryptography
 
@@ -470,4 +468,4 @@ licensing fees.
 We strongly recommend downstream consumers verify the type of FFmpeg support
 configured and modify as required.  More information on instructions to verify
 can be found here
-https://electronjs.org/docs/development/upgrading-chromium#verify-ffmpeg-support
+<https://electronjs.org/docs/development/upgrading-chromium#verify-ffmpeg-support>