Update markdown docs formatting

.vscode/cSpell.json

@@ -216,6 +216,7 @@
         "Nums",
         "oidc",
         "oldcolor",
+        "openid",
         "origin",
         "orthogonalize",
         "overclamped",
@@ -242,8 +243,10 @@
         "preallocated",
         "prefetch",
         "prerelease",
+        "projectwise",
         "pseudolocalize",
         "Queryable",
+        "rbac",
         "readlink",
         "readonly",
         "rebased",

.vscode/settings.json

@@ -115,7 +115,8 @@
   "eslint.format.enable": true,
   "eslint.lintTask.enable": true,
   "editor.codeActionsOnSave": {
-    "editor.action.fixAll": true, // first run the default formatter, it handles whitespace better
+    "source.fixAll.markdownlint": true, // first run the markdown linter
+    "editor.action.fixAll": true, // Run the default formatter before eslint, it handles whitespace better
     "source.fixAll.eslint": true // then run ESLint auto-fix
   }
 }

CONTRIBUTING.md

@@ -30,8 +30,8 @@ Before you create a new issue, please do a search in [open issues](https://githu
 If you find that your issue already exists, please add relevant comments and your [reaction](/~https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments).
 Use a reaction in place of a "+1" comment:
 
-* 👍 - upvote
-* 👎 - downvote
+- 👍 - upvote
+- 👎 - downvote
 
 If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.
 
@@ -47,14 +47,14 @@ The more information you can provide, the more likely someone will be successful
 
 Please include the following with each issue:
 
-* A short description of the issue that becomes the title
-* Versions of relevant iModel.js packages
-* Minimal steps to reproduce the issue or a code snippet that demonstrates the issue
-* What you expected to see, versus what you actually saw
-* Images that help explain the issue
-* Any relevant error messages, logs, or other details
-* Impact of the issue
-* Use the [`bug`](/~https://github.com/imodeljs/imodeljs/labels/bug) or [`enhancement`](/~https://github.com/imodeljs/imodeljs/labels/enhancement) label to identify the type of issue you are filing
+- A short description of the issue that becomes the title
+- Versions of relevant iModel.js packages
+- Minimal steps to reproduce the issue or a code snippet that demonstrates the issue
+- What you expected to see, versus what you actually saw
+- Images that help explain the issue
+- Any relevant error messages, logs, or other details
+- Impact of the issue
+- Use the [`bug`](/~https://github.com/imodeljs/imodeljs/labels/bug) or [`enhancement`](/~https://github.com/imodeljs/imodeljs/labels/enhancement) label to identify the type of issue you are filing
 
 Don't feel bad if the developers can't reproduce the issue right away.
 They will simply ask for more information!
@@ -86,10 +86,10 @@ Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for
 
 We welcome contributions, large or small, including:
 
-* Bug fixes
-* New features
-* Documentation corrections or additions
-* Example code snippets
-* Sample data
+- Bug fixes
+- New features
+- Documentation corrections or additions
+- Example code snippets
+- Sample data
 
 Thank you for taking the time to contribute to open source and making great projects like iModel.js possible!

README.md

@@ -18,11 +18,11 @@ Each package has its own **node_modules** directory that contains symbolic links
 
 ## Prerequisites
 
-* [Git](https://git-scm.com/)
-* [Node](https://nodejs.org/en/): an installation of the latest security patch of Node 12. The Node installation also includes the **npm** package manager.
-* [Rush](/~https://github.com/Microsoft/web-build-tools/wiki/Rush): to install `npm install -g @microsoft/rush`
-* [TypeScript](https://www.typescriptlang.org/): this is listed as a devDependency, so if you're building it from source, you will get it with `rush install`.
-* [Visual Studio Code](https://code.visualstudio.com/): an optional dependency, but the repository structure is optimized for its use
+- [Git](https://git-scm.com/)
+- [Node](https://nodejs.org/en/): an installation of the latest security patch of Node 12. The Node installation also includes the **npm** package manager.
+- [Rush](/~https://github.com/Microsoft/web-build-tools/wiki/Rush): to install `npm install -g @microsoft/rush`
+- [TypeScript](https://www.typescriptlang.org/): this is listed as a devDependency, so if you're building it from source, you will get it with `rush install`.
+- [Visual Studio Code](https://code.visualstudio.com/): an optional dependency, but the repository structure is optimized for its use
 
 > See [supported platforms](./docs/learning/SupportedPlatforms.md) for further information.
 

SECURITY.md

@@ -12,11 +12,11 @@ Report security concerns in third-party modules to the person or team maintainin
 
 We ask that:
 
-* You give us reasonable time to investigate and mitigate an issue you report before making public any information about the report or sharing such information with others.
-* You do not interact with an individual account (which includes modifying or accessing data from the account) if the account owner has not consented to such actions.
-* You make a good faith effort to avoid privacy violations and disruptions to others, including (but not limited to) unauthorized access to or destruction of data, and interruption or degradation of our services.
-* You do not exploit a security issue you discover for any reason. (This includes demonstrating additional risk, such as attempted compromise of sensitive company data or probing for additional issues.)
-* You do not intentionally violate any other applicable laws or regulations, including (but not limited to) laws and regulations prohibiting the unauthorized access to data.
-* For the purposes of this policy, you are not authorized to access user data or company data, including (but not limited to) personally identifiable information and data relating to an identified or identifiable natural person.
+- You give us reasonable time to investigate and mitigate an issue you report before making public any information about the report or sharing such information with others.
+- You do not interact with an individual account (which includes modifying or accessing data from the account) if the account owner has not consented to such actions.
+- You make a good faith effort to avoid privacy violations and disruptions to others, including (but not limited to) unauthorized access to or destruction of data, and interruption or degradation of our services.
+- You do not exploit a security issue you discover for any reason. (This includes demonstrating additional risk, such as attempted compromise of sensitive company data or probing for additional issues.)
+- You do not intentionally violate any other applicable laws or regulations, including (but not limited to) laws and regulations prohibiting the unauthorized access to data.
+- For the purposes of this policy, you are not authorized to access user data or company data, including (but not limited to) personally identifiable information and data relating to an identified or identifiable natural person.
 
 For more information, please read Bentley's [responsible disclosure](https://www.bentley.com/responsible_disclosure.pdf) guidelines.

docs/changehistory/1.0.0.md

@@ -34,8 +34,8 @@ Here is an example of how to adjust your source code:
 
 Removed the following parameters to `IModelDb.open` to simplify the implementation:
 
-* [OpenParams](https://www.imodeljs.org/v1/reference/imodeljs-backend/imodels/openparams).pullOnly(): Use OpenParams.fixedVersion() or OpenParams.pullAndPush()
-* AccessMode: Using OpenParams.fixedVersion() always causes the briefcase to be shared, and using OpenParams.pullAndPush() always causes the briefcase to be exclusive.
+- [OpenParams](https://www.imodeljs.org/v1/reference/imodeljs-backend/imodels/openparams).pullOnly(): Use OpenParams.fixedVersion() or OpenParams.pullAndPush()
+- AccessMode: Using OpenParams.fixedVersion() always causes the briefcase to be shared, and using OpenParams.pullAndPush() always causes the briefcase to be exclusive.
 
 ## Changes to OidcAgentClient
 
@@ -61,15 +61,15 @@ Removed or modified some properties used to feature-gate various tile-related fe
 
 Frontend:
 
-* Removed `TileAdmin.requestTilesWithoutEdges`. Tiles are now always requested without edges if edges are not required.
-* Removed `TileAdmin.elideEmptyChildContentRequests`. Such requests are now always elided.
-* `TileAdmin.enableInstancing` now defaults to `true` instead of `false`.
-* Previously, if `TileAdmin.retryInterval` was undefined, requests for tile content and tile tree JSON would not be memoized. Now, they are always memoized, and the interval defaults to 1000ms if not explicitly defined.
-* Previously, requests for tile content would by default use POST method and responses would not be cacheable. Now by default they use GET and responses are cacheable.
+- Removed `TileAdmin.requestTilesWithoutEdges`. Tiles are now always requested without edges if edges are not required.
+- Removed `TileAdmin.elideEmptyChildContentRequests`. Such requests are now always elided.
+- `TileAdmin.enableInstancing` now defaults to `true` instead of `false`.
+- Previously, if `TileAdmin.retryInterval` was undefined, requests for tile content and tile tree JSON would not be memoized. Now, they are always memoized, and the interval defaults to 1000ms if not explicitly defined.
+- Previously, requests for tile content would by default use POST method and responses would not be cacheable. Now by default they use GET and responses are cacheable.
 
 Backend:
 
-* Removed `IModelHostConfiguration.useTileContentThreadPool`. The thread pool is now always used.
+- Removed `IModelHostConfiguration.useTileContentThreadPool`. The thread pool is now always used.
 
 ## Changes to RPC type marshaling system
 
@@ -87,30 +87,30 @@ This change breaks RPC interface [IModelReadRpcInterface](https://www.imodeljs.o
 
 Backend:
 
-* Renamed `IModelDb.queryPage` to `IModelDb.queryRows`. This method is also marked `internal` and user should not call it directly. Instead user should always use [IModelDb.query](https://www.imodeljs.org/v1/reference/imodeljs-backend/imodels/imodeldb/query). This method now also throw exception if query prepare fails.
-* Changed method signature for [IModelDb.query](https://www.imodeljs.org/v1/reference/imodeljs-backend/imodels/imodeldb/query). But first two parameters are same.
+- Renamed `IModelDb.queryPage` to `IModelDb.queryRows`. This method is also marked `internal` and user should not call it directly. Instead user should always use [IModelDb.query](https://www.imodeljs.org/v1/reference/imodeljs-backend/imodels/imodeldb/query). This method now also throw exception if query prepare fails.
+- Changed method signature for [IModelDb.query](https://www.imodeljs.org/v1/reference/imodeljs-backend/imodels/imodeldb/query). But first two parameters are same.
 
 Common:
 
-* Renamed `IModelDb.queryPage` to `IModelDb.queryRows`.
-* Removed `queryRowCount`method from [IModelReadRpcInterface](https://www.imodeljs.org/v1/reference/imodeljs-common/rpcinterface/imodelreadrpcinterface)
+- Renamed `IModelDb.queryPage` to `IModelDb.queryRows`.
+- Removed `queryRowCount`method from [IModelReadRpcInterface](https://www.imodeljs.org/v1/reference/imodeljs-common/rpcinterface/imodelreadrpcinterface)
 
 Frontend:
 
-* Renamed `IModelConnection.queryPage` to `IModelConnection.queryRows`. This method is also marked `internal` and user should not call it directly. Instead user should always use [IModelConnection.query](https://www.imodeljs.org/v1/reference/imodeljs-frontend/imodelconnection/imodelconnection/query). This method now also throw exception if query prepare fails.
-* Changed method signature for [IModelConnection.query](https://www.imodeljs.org/v1/reference/imodeljs-frontend/imodelconnection/imodelconnection/query). But first two parameters are same.
+- Renamed `IModelConnection.queryPage` to `IModelConnection.queryRows`. This method is also marked `internal` and user should not call it directly. Instead user should always use [IModelConnection.query](https://www.imodeljs.org/v1/reference/imodeljs-frontend/imodelconnection/imodelconnection/query). This method now also throw exception if query prepare fails.
+- Changed method signature for [IModelConnection.query](https://www.imodeljs.org/v1/reference/imodeljs-frontend/imodelconnection/imodelconnection/query). But first two parameters are same.
 
 ### How can you update code
 
 ```ts
-    const rows = await imodel.queryPage("SELECT ECInstanceId FROM bis.Element LIMIT 1");
+const rows = await imodel.queryPage("SELECT ECInstanceId FROM bis.Element LIMIT 1");
 ```
 
   can be be changed to following.
 
 ```ts
-    const rows = [];
-    for await (const row of imodel.query("SELECT ECInstanceId FROM bis.Element LIMIT 1")) {
-      rows.push(row);
-    }
+const rows = [];
+for await (const row of imodel.query("SELECT ECInstanceId FROM bis.Element LIMIT 1")) {
+  rows.push(row);
+}
 ```