Docs: adding API reference documentation support for the packages libraries. (#21931)

* trying out api-extractor.

* works with our setup of build.

* wip.

* changed the packages so it works better with the api-extractor.

* Changes to make the api-extractor to work.

* cleaned up the api-extractor config files.

* added some more documentation.

* added tsdoc-metadata to gitignore.

* removed the generated docs (will do that in another PR).

* added execute permission to script for generating dosc.

* added so we will push generated docs to branch.

* will clean packages_api on abort.

* Fixed failing tests.

* fixed formatting issue with typedoc comment.

* temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved

* temporary enabled bable namespaces.

* updated build script.

* updated script.

* updated script with some colors.

* changed to camelCase.

* removed spacing.

* Starting to add documentation guidelines.

* added examples headline.

* added parameters and return values.

* Fixed merge error.

* changed so we use the eslint ignore syntax.

* changed to correct eslint ingnore comment.

* fixed some spelling errors reported by codespell.

* added script to generate docs in current folder.

* lerna bootstrap.

* removed file that should be ignored.

* updated locKFILE.

* referenced the code comments guidelines.

* updated packages.

* updated deps.

packages/grafana-runtime/api-extractor.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../api-extractor.json"
+}

packages/grafana-runtime/package.json

@@ -18,7 +18,8 @@
     "typecheck": "tsc --noEmit",
     "clean": "rimraf ./dist ./compiled",
     "bundle": "rollup -c rollup.config.ts",
-    "build": "grafana-toolkit package:build --scope=runtime"
+    "build": "grafana-toolkit package:build --scope=runtime",
+    "docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log"
   },
   "dependencies": {
     "@grafana/data": "6.7.0-pre",

packages/grafana-runtime/src/index.ts

@@ -1,7 +1,11 @@
+/**
+ * A library containing services, configurations etc. used to interact with the Grafana engine.
+ *
+ * @packageDocumentation
+ */
 export * from './services';
 export * from './config';
 export * from './types';
 export { loadPluginCss, SystemJS } from './utils/plugin';
 export { reportMetaAnalytics } from './utils/analytics';
-
 export { DataSourceWithBackend } from './utils/DataSourceWithBackend';

packages/grafana-runtime/src/utils/DataSourceWithBackend.ts

@@ -71,7 +71,7 @@ export class DataSourceWithBackend<
   }
 
   /**
-   * This makes the arrow libary loading async.
+   * This makes the arrow library loading async.
    */
   async toDataQueryResponse(rsp: any): Promise<DataQueryResponse> {
     const { resultsToDataFrames } = await import(