Docs: adding first version of the auto-generated packages API docs. (#22107)

* 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 menu options.

* added parameters and return values.

* Fixed merge error.

* Added first version of auto-generated docs.

* 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.

* updated api docs.

* lerna bootstrap.

* added eror to the ingore words list.

* removed file that should be ignored.

* updated locKFILE.

* referenced the code comments guidelines.

* updated packages.

* updated deps.

* updated the autogenerated dosc.

* adding missing new line.

docs/sources/packages_api/data/panelevents/componentdidmount.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "componentDidMount"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.componentDidMount variable
+
+### PanelEvents.componentDidMount variable
+
+<b>Signature</b>
+
+```typescript
+componentDidMount: import("./appEvents").AppEvent<undefined>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { componentDidMount } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/dataerror.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "dataError"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.dataError variable
+
+### PanelEvents.dataError variable
+
+<b>Signature</b>
+
+```typescript
+dataError: import("./appEvents").AppEvent<DataQueryError>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { dataError } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/datareceived.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "dataReceived"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.dataReceived variable
+
+### PanelEvents.dataReceived variable
+
+<b>Signature</b>
+
+```typescript
+dataReceived: import("./appEvents").AppEvent<any[]>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { dataReceived } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/datasnapshotload.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "dataSnapshotLoad"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.dataSnapshotLoad variable
+
+### PanelEvents.dataSnapshotLoad variable
+
+<b>Signature</b>
+
+```typescript
+dataSnapshotLoad: import("./appEvents").AppEvent<any[]>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { dataSnapshotLoad } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/editmodeinitialized.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "editModeInitialized"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.editModeInitialized variable
+
+### PanelEvents.editModeInitialized variable
+
+<b>Signature</b>
+
+```typescript
+editModeInitialized: import("./appEvents").AppEvent<undefined>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { editModeInitialized } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/initpanelactions.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "initPanelActions"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.initPanelActions variable
+
+### PanelEvents.initPanelActions variable
+
+<b>Signature</b>
+
+```typescript
+initPanelActions: import("./appEvents").AppEvent<AngularPanelMenuItem[]>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { initPanelActions } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/panelchangeview.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "panelChangeView"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.panelChangeView variable
+
+### PanelEvents.panelChangeView variable
+
+<b>Signature</b>
+
+```typescript
+panelChangeView: import("./appEvents").AppEvent<PanelChangeViewPayload>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { panelChangeView } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/panelchangeviewpayload.md

@@ -0,0 +1,65 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "PanelChangeViewPayload"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.PanelChangeViewPayload interface
+
+Payloads
+
+<b>Signature</b>
+
+```typescript
+interface PanelChangeViewPayload 
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { PanelChangeViewPayload } = PanelEvents;
+```
+<b>Properties</b>
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [edit](#edit-property) | <code>boolean</code> |  |
+|  [fullscreen](#fullscreen-property) | <code>boolean</code> |  |
+|  [panelId](#panelid-property) | <code>number</code> |  |
+|  [toggle](#toggle-property) | <code>boolean</code> |  |
+
+### edit property
+
+<b>Signature</b>
+
+```typescript
+edit?: boolean;
+```
+
+### fullscreen property
+
+<b>Signature</b>
+
+```typescript
+fullscreen?: boolean;
+```
+
+### panelId property
+
+<b>Signature</b>
+
+```typescript
+panelId?: number;
+```
+
+### toggle property
+
+<b>Signature</b>
+
+```typescript
+toggle?: boolean;
+```

docs/sources/packages_api/data/panelevents/panelinitialized.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "panelInitialized"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.panelInitialized variable
+
+### PanelEvents.panelInitialized variable
+
+<b>Signature</b>
+
+```typescript
+panelInitialized: import("./appEvents").AppEvent<undefined>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { panelInitialized } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/panelsizechanged.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "panelSizeChanged"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.panelSizeChanged variable
+
+### PanelEvents.panelSizeChanged variable
+
+<b>Signature</b>
+
+```typescript
+panelSizeChanged: import("./appEvents").AppEvent<undefined>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { panelSizeChanged } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/panelteardown.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "panelTeardown"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.panelTeardown variable
+
+### PanelEvents.panelTeardown variable
+
+<b>Signature</b>
+
+```typescript
+panelTeardown: import("./appEvents").AppEvent<undefined>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { panelTeardown } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/refresh.md

@@ -0,0 +1,27 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "refresh"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.refresh variable
+
+### PanelEvents.refresh variable
+
+Events
+
+<b>Signature</b>
+
+```typescript
+refresh: import("./appEvents").AppEvent<undefined>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { refresh } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/render.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "render"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.render variable
+
+### PanelEvents.render variable
+
+<b>Signature</b>
+
+```typescript
+render: import("./appEvents").AppEvent<any>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { render } = PanelEvents;
+```

docs/sources/packages_api/data/panelevents/viewmodechanged.md

@@ -0,0 +1,25 @@
++++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "viewModeChanged"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
++++
+
+## PanelEvents.viewModeChanged variable
+
+### PanelEvents.viewModeChanged variable
+
+<b>Signature</b>
+
+```typescript
+viewModeChanged: import("./appEvents").AppEvent<undefined>
+```
+<b>Import</b>
+
+```typescript
+import { PanelEvents } from '@grafana/data';
+const { viewModeChanged } = PanelEvents;
+```