Add Documentation view (#1579)

## Changes

The new view is positioned below the Configuration view. It contains a
Quick Start Guide and links to various documentation pages.

By default it's visible and expanded, but since it's a separate "view",
users can close it, move it to a different place, or hide it completely.

<img width="428" alt="Screenshot 2025-02-27 at 10 03 26"
src="https://github.com/user-attachments/assets/41a06a91-7867-4529-aae5-9a44bd3d4aa9"
/>


And that how it looks with experimental views enabled:

<img width="428" alt="Screenshot 2025-02-27 at 10 02 40"
src="https://github.com/user-attachments/assets/aa5159ab-5bb5-49fc-8dc1-bb1b1858d025"
/>



## Tests

Manually

Author: ilia-db

packages/databricks-vscode/package.json

@@ -419,6 +419,11 @@
                     "id": "configurationView",
                     "name": "Configuration"
                 },
+                {
+                    "id": "clusterView",
+                    "when": "databricks.feature.views.cluster",
+                    "name": "Clusters"
+                },
                 {
                     "id": "dabsResourceExplorerView",
                     "name": "Bundle Resource Explorer",
@@ -434,12 +439,11 @@
                 {
                     "id": "workspaceFsView",
                     "name": "Workspace explorer",
-                    "when": "config.databricks.sync.destinationType == workspace && databricks.feature.views.workspace"
+                    "when": "databricks.feature.views.workspace"
                 },
                 {
-                    "id": "clusterView",
-                    "when": "databricks.feature.views.cluster",
-                    "name": "Clusters"
+                    "id": "databricksDocsView",
+                    "name": "Documentation"
                 }
             ]
         },

packages/databricks-vscode/src/configuration/DatabricksWorkspace.ts

@@ -23,7 +23,7 @@ export class DatabricksWorkspace {
 
     get workspaceFsRoot(): RemoteUri {
         return new RemoteUri(
-            Uri.from({scheme: "wsfs", path: `/Users/${this.userName}/.ide`})
+            Uri.from({scheme: "wsfs", path: `/Users/${this.userName}`})
         );
     }
 

packages/databricks-vscode/src/extension.ts

@@ -73,6 +73,7 @@ import {WorkspaceFolderManager} from "./vscode-objs/WorkspaceFolderManager";
 import {SyncCommands} from "./sync/SyncCommands";
 import {CodeSynchronizer} from "./sync";
 import {BundlePipelinesManager} from "./bundle/BundlePipelinesManager";
+import {DocsViewTreeDataProvider} from "./ui/docs-view/DocsViewTreeDataProvider";
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageJson = require("../package.json");
@@ -834,6 +835,15 @@ export async function activate(
         debugWorkflowFactory
     );
 
+    const docsViewTreeDataProvider = new DocsViewTreeDataProvider();
+    context.subscriptions.push(
+        window.registerTreeDataProvider(
+            "databricksDocsView",
+            docsViewTreeDataProvider
+        ),
+        docsViewTreeDataProvider
+    );
+
     showQuickStartOnFirstUse(context).catch((e) => {
         logging.NamedLogger.getOrCreate("Extension").error(
             "Quick Start error",

packages/databricks-vscode/src/test/e2e/bundle_variables.e2e.ts

@@ -158,6 +158,8 @@ describe("Bundle Variables", async function () {
             | CustomTreeSection
             | undefined;
         assert(section);
+        await (await section.elem).click();
+
         await waitForTreeItems(section, 5_000);
 
         const action = await section.getAction(

packages/databricks-vscode/src/test/e2e/utils/commonUtils.ts

@@ -15,6 +15,7 @@ const ViewSectionTypes = [
     "WORKSPACE EXPLORER",
     "BUNDLE RESOURCE EXPLORER",
     "BUNDLE VARIABLES",
+    "DOCUMENTATION",
 ] as const;
 export type ViewSectionType = (typeof ViewSectionTypes)[number];
 
@@ -73,7 +74,6 @@ export async function getViewSection(
     }
 
     await section!.expand();
-    await (await section!.elem).click();
     return section;
 }
 

packages/databricks-vscode/src/ui/docs-view/DocsViewTreeDataProvider.ts

@@ -0,0 +1,111 @@
+import {
+    Disposable,
+    ThemeIcon,
+    TreeDataProvider,
+    TreeItem,
+    TreeItemCollapsibleState,
+    Uri,
+} from "vscode";
+import {logging} from "@databricks/databricks-sdk";
+import {Loggers} from "../../logger";
+
+export interface DocsTreeItem extends TreeItem {
+    id?: string;
+}
+
+export class DocsViewTreeDataProvider
+    implements TreeDataProvider<DocsTreeItem>, Disposable
+{
+    constructor() {}
+
+    dispose() {}
+
+    getTreeItem(element: DocsTreeItem): TreeItem | Thenable<TreeItem> {
+        return element;
+    }
+
+    async getChildren(
+        parent?: DocsTreeItem | undefined
+    ): Promise<Array<DocsTreeItem>> {
+        try {
+            return await this.getDocsChildren(parent);
+        } catch (e) {
+            logging.NamedLogger.getOrCreate(Loggers.Extension).error(
+                `Error getting children for docs view`,
+                e
+            );
+            return [];
+        }
+    }
+
+    private async getDocsChildren(
+        parent?: DocsTreeItem | undefined
+    ): Promise<DocsTreeItem[]> {
+        if (parent !== undefined) {
+            return [];
+        }
+
+        const quickStartItem = new TreeItem(
+            "Quick Start Guide",
+            TreeItemCollapsibleState.None
+        );
+        quickStartItem.iconPath = new ThemeIcon("preview");
+        quickStartItem.command = {
+            command: "databricks.quickstart.open",
+            title: "Show Quick Start Guide",
+        };
+
+        const items: DocsTreeItem[] = [quickStartItem];
+
+        const baseUrl = "https://docs.databricks.com/";
+        const docLinks = [
+            {
+                label: "Setup authentication",
+                path: "dev-tools/vscode-ext/authentication",
+            },
+            {
+                label: "Configure your project",
+                path: "dev-tools/vscode-ext/configure",
+            },
+            {
+                label: "Work with Databricks Asset Bundles",
+                path: "dev-tools/vscode-ext/bundles",
+            },
+            {
+                label: "Run files on a cluster",
+                path: "dev-tools/vscode-ext/run",
+            },
+            {
+                label: "Run files with Databricks Connect",
+                path: "dev-tools/vscode-ext/databricks-connect",
+            },
+            {
+                label: "Run notebooks cell by cell",
+                path: "dev-tools/vscode-ext/notebooks",
+            },
+            {
+                label: "Run tests on a cluster",
+                path: "dev-tools/vscode-ext/pytest",
+            },
+            {
+                label: "Explore extension settings",
+                path: "dev-tools/vscode-ext/settings",
+            },
+            {
+                label: "Troubleshoot problems",
+                path: "dev-tools/vscode-ext/troubleshooting",
+            },
+        ];
+        for (const doc of docLinks) {
+            const item = new TreeItem(doc.label, TreeItemCollapsibleState.None);
+            item.iconPath = new ThemeIcon("link");
+            item.command = {
+                command: "vscode.open",
+                title: "Open URL",
+                arguments: [Uri.parse(`${baseUrl}${doc.path}`)],
+            };
+            items.push(item);
+        }
+        return items;
+    }
+}