diff --git a/docs/account/account-oauth2.rst b/docs/account/account-oauth2.rst deleted file mode 100644 index 0a48f1979..000000000 --- a/docs/account/account-oauth2.rst +++ /dev/null @@ -1,13 +0,0 @@ - -OAuth -===== - -Configure OAuth 2.0 application registrations for Databricks - -.. toctree:: - :maxdepth: 1 - - custom_app_integration - o_auth_published_apps - published_app_integration - service_principal_secrets \ No newline at end of file diff --git a/docs/account/billable_usage.rst b/docs/account/billing/billable_usage.rst similarity index 100% rename from docs/account/billable_usage.rst rename to docs/account/billing/billable_usage.rst diff --git a/docs/account/budgets.rst b/docs/account/billing/budgets.rst similarity index 100% rename from docs/account/budgets.rst rename to docs/account/billing/budgets.rst diff --git a/docs/account/account-billing.rst b/docs/account/billing/index.rst similarity index 61% rename from docs/account/account-billing.rst rename to docs/account/billing/index.rst index ea434aa29..522f6f5fd 100644 --- a/docs/account/account-billing.rst +++ b/docs/account/billing/index.rst @@ -5,8 +5,8 @@ Billing Configure different aspects of Databricks billing and usage. .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - billable_usage - budgets - log_delivery \ No newline at end of file + billable_usage + budgets + log_delivery \ No newline at end of file diff --git a/docs/account/log_delivery.rst b/docs/account/billing/log_delivery.rst similarity index 100% rename from docs/account/log_delivery.rst rename to docs/account/billing/log_delivery.rst diff --git a/docs/account/account-catalog.rst b/docs/account/catalog/index.rst similarity index 69% rename from docs/account/account-catalog.rst rename to docs/account/catalog/index.rst index d235579af..c774d529d 100644 --- a/docs/account/account-catalog.rst +++ b/docs/account/catalog/index.rst @@ -5,8 +5,8 @@ Unity Catalog Configure data governance with Unity Catalog for metastores, catalogs, schemas, tables, external locations, and storage credentials .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - metastore_assignments - metastores - storage_credentials \ No newline at end of file + metastore_assignments + metastores + storage_credentials \ No newline at end of file diff --git a/docs/account/metastore_assignments.rst b/docs/account/catalog/metastore_assignments.rst similarity index 100% rename from docs/account/metastore_assignments.rst rename to docs/account/catalog/metastore_assignments.rst diff --git a/docs/account/metastores.rst b/docs/account/catalog/metastores.rst similarity index 100% rename from docs/account/metastores.rst rename to docs/account/catalog/metastores.rst diff --git a/docs/account/storage_credentials.rst b/docs/account/catalog/storage_credentials.rst similarity index 100% rename from docs/account/storage_credentials.rst rename to docs/account/catalog/storage_credentials.rst diff --git a/docs/account/access_control.rst b/docs/account/iam/access_control.rst similarity index 100% rename from docs/account/access_control.rst rename to docs/account/iam/access_control.rst diff --git a/docs/account/groups.rst b/docs/account/iam/groups.rst similarity index 100% rename from docs/account/groups.rst rename to docs/account/iam/groups.rst diff --git a/docs/account/account-iam.rst b/docs/account/iam/index.rst similarity index 63% rename from docs/account/account-iam.rst rename to docs/account/iam/index.rst index 1c74cd15a..1939a1a1e 100644 --- a/docs/account/account-iam.rst +++ b/docs/account/iam/index.rst @@ -5,10 +5,10 @@ Identity and Access Management Manage users, service principals, groups and their permissions in Accounts and Workspaces .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - access_control - groups - service_principals - users - workspace_assignment \ No newline at end of file + access_control + groups + service_principals + users + workspace_assignment \ No newline at end of file diff --git a/docs/account/service_principals.rst b/docs/account/iam/service_principals.rst similarity index 100% rename from docs/account/service_principals.rst rename to docs/account/iam/service_principals.rst diff --git a/docs/account/users.rst b/docs/account/iam/users.rst similarity index 100% rename from docs/account/users.rst rename to docs/account/iam/users.rst diff --git a/docs/account/workspace_assignment.rst b/docs/account/iam/workspace_assignment.rst similarity index 100% rename from docs/account/workspace_assignment.rst rename to docs/account/iam/workspace_assignment.rst diff --git a/docs/account/index.rst b/docs/account/index.rst index 8993d2120..8179cb395 100644 --- a/docs/account/index.rst +++ b/docs/account/index.rst @@ -5,11 +5,11 @@ Account APIs These APIs are available from AccountClient .. toctree:: - :maxdepth: 1 - - account-iam - account-catalog - account-settings - account-provisioning - account-billing - account-oauth2 \ No newline at end of file + :maxdepth: 1 + + iam/index + catalog/index + settings/index + provisioning/index + billing/index + oauth2/index \ No newline at end of file diff --git a/docs/account/custom_app_integration.rst b/docs/account/oauth2/custom_app_integration.rst similarity index 100% rename from docs/account/custom_app_integration.rst rename to docs/account/oauth2/custom_app_integration.rst diff --git a/docs/account/oauth2/index.rst b/docs/account/oauth2/index.rst new file mode 100644 index 000000000..a4663ef6b --- /dev/null +++ b/docs/account/oauth2/index.rst @@ -0,0 +1,13 @@ + +OAuth +===== + +Configure OAuth 2.0 application registrations for Databricks + +.. toctree:: + :maxdepth: 1 + + custom_app_integration + o_auth_published_apps + published_app_integration + service_principal_secrets \ No newline at end of file diff --git a/docs/account/o_auth_published_apps.rst b/docs/account/oauth2/o_auth_published_apps.rst similarity index 100% rename from docs/account/o_auth_published_apps.rst rename to docs/account/oauth2/o_auth_published_apps.rst diff --git a/docs/account/published_app_integration.rst b/docs/account/oauth2/published_app_integration.rst similarity index 100% rename from docs/account/published_app_integration.rst rename to docs/account/oauth2/published_app_integration.rst diff --git a/docs/account/service_principal_secrets.rst b/docs/account/oauth2/service_principal_secrets.rst similarity index 100% rename from docs/account/service_principal_secrets.rst rename to docs/account/oauth2/service_principal_secrets.rst diff --git a/docs/account/credentials.rst b/docs/account/provisioning/credentials.rst similarity index 100% rename from docs/account/credentials.rst rename to docs/account/provisioning/credentials.rst diff --git a/docs/account/encryption_keys.rst b/docs/account/provisioning/encryption_keys.rst similarity index 100% rename from docs/account/encryption_keys.rst rename to docs/account/provisioning/encryption_keys.rst diff --git a/docs/account/account-provisioning.rst b/docs/account/provisioning/index.rst similarity index 60% rename from docs/account/account-provisioning.rst rename to docs/account/provisioning/index.rst index 5107ab3ad..46a328b68 100644 --- a/docs/account/account-provisioning.rst +++ b/docs/account/provisioning/index.rst @@ -5,12 +5,12 @@ Provisioning Resource management for secure Databricks Workspace deployment, cross-account IAM roles, storage, encryption, networking and private access. .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - credentials - encryption_keys - networks - private_access - storage - vpc_endpoints - workspaces \ No newline at end of file + credentials + encryption_keys + networks + private_access + storage + vpc_endpoints + workspaces \ No newline at end of file diff --git a/docs/account/networks.rst b/docs/account/provisioning/networks.rst similarity index 100% rename from docs/account/networks.rst rename to docs/account/provisioning/networks.rst diff --git a/docs/account/private_access.rst b/docs/account/provisioning/private_access.rst similarity index 100% rename from docs/account/private_access.rst rename to docs/account/provisioning/private_access.rst diff --git a/docs/account/storage.rst b/docs/account/provisioning/storage.rst similarity index 100% rename from docs/account/storage.rst rename to docs/account/provisioning/storage.rst diff --git a/docs/account/vpc_endpoints.rst b/docs/account/provisioning/vpc_endpoints.rst similarity index 100% rename from docs/account/vpc_endpoints.rst rename to docs/account/provisioning/vpc_endpoints.rst diff --git a/docs/account/workspaces.rst b/docs/account/provisioning/workspaces.rst similarity index 100% rename from docs/account/workspaces.rst rename to docs/account/provisioning/workspaces.rst diff --git a/docs/account/account-settings.rst b/docs/account/settings/index.rst similarity index 55% rename from docs/account/account-settings.rst rename to docs/account/settings/index.rst index 862e94f94..ece6a3255 100644 --- a/docs/account/account-settings.rst +++ b/docs/account/settings/index.rst @@ -5,8 +5,8 @@ Settings Manage security settings for Accounts and Workspaces .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - ip_access_lists - network_connectivity - settings \ No newline at end of file + ip_access_lists + network_connectivity + settings \ No newline at end of file diff --git a/docs/account/ip_access_lists.rst b/docs/account/settings/ip_access_lists.rst similarity index 100% rename from docs/account/ip_access_lists.rst rename to docs/account/settings/ip_access_lists.rst diff --git a/docs/account/network_connectivity.rst b/docs/account/settings/network_connectivity.rst similarity index 100% rename from docs/account/network_connectivity.rst rename to docs/account/settings/network_connectivity.rst diff --git a/docs/account/settings.rst b/docs/account/settings/settings.rst similarity index 100% rename from docs/account/settings.rst rename to docs/account/settings/settings.rst diff --git a/docs/gen-client-docs.py b/docs/gen-client-docs.py index 37ae3c5f8..23ab1a5e6 100644 --- a/docs/gen-client-docs.py +++ b/docs/gen-client-docs.py @@ -299,7 +299,13 @@ def service_docs(self, client_inst) -> list[ServiceDoc]: def _should_document(obj): return is_dataclass(obj) or (type(obj) == type and issubclass(obj, Enum)) + @staticmethod + def _make_folder_if_not_exists(folder): + if not os.path.exists(folder): + os.makedirs(folder) + def write_dataclass_docs(self): + self._make_folder_if_not_exists(f'{__dir__}/dbdataclasses') for pkg in self.packages: module = importlib.import_module(f'databricks.sdk.service.{pkg.name}') all_members = [name for name, _ in inspect.getmembers(module, predicate=self._should_document)] @@ -333,8 +339,10 @@ def load_client(self, client, folder, label, description): service_docs = self.service_docs(client) for svc in service_docs: client_services.append(svc.service_name) - package_to_services[svc.tag.package.name].append(svc.service_name) - with open(f'{__dir__}/{folder}/{svc.service_name}.rst', 'w') as f: + package = svc.tag.package.name + package_to_services[package].append(svc.service_name) + self._make_folder_if_not_exists(f'{__dir__}/{folder}/{package}') + with open(f'{__dir__}/{folder}/{package}/{svc.service_name}.rst', 'w') as f: f.write(svc.as_rst()) ordered_packages = [] for pkg in self.packages: @@ -345,8 +353,10 @@ def load_client(self, client, folder, label, description): self._write_client_packages(folder, label, description, ordered_packages) def _write_client_packages(self, folder: str, label: str, description: str, packages: list[str]): + """Writes out the top-level index for the APIs supported by a client.""" + self._make_folder_if_not_exists(f'{__dir__}/{folder}') with open(f'{__dir__}/{folder}/index.rst', 'w') as f: - all = "\n ".join([f'{folder}-{name}' for name in packages]) + all = "\n ".join([f'{name}/index' for name in packages]) f.write(f''' {label} {'=' * len(label)} @@ -354,13 +364,15 @@ def _write_client_packages(self, folder: str, label: str, description: str, pack {description} .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - {all}''') + {all}''') def _write_client_package_doc(self, folder: str, pkg: Package, services: list[str]): - with open(f'{__dir__}/{folder}/{folder}-{pkg.name}.rst', 'w') as f: - all = "\n ".join(services) + """Writes out the index for a single package supported by a client.""" + self._make_folder_if_not_exists(f'{__dir__}/{folder}/{pkg.name}') + with open(f'{__dir__}/{folder}/{pkg.name}/index.rst', 'w') as f: + all = "\n ".join(services) f.write(f''' {pkg.label} {'=' * len(pkg.label)} @@ -368,9 +380,9 @@ def _write_client_package_doc(self, folder: str, pkg: Package, services: list[st {pkg.description} .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - {all}''') + {all}''') if __name__ == '__main__': diff --git a/docs/images/styles.css b/docs/images/styles.css deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/workspace/artifact_allowlists.rst b/docs/workspace/catalog/artifact_allowlists.rst similarity index 100% rename from docs/workspace/artifact_allowlists.rst rename to docs/workspace/catalog/artifact_allowlists.rst diff --git a/docs/workspace/catalogs.rst b/docs/workspace/catalog/catalogs.rst similarity index 100% rename from docs/workspace/catalogs.rst rename to docs/workspace/catalog/catalogs.rst diff --git a/docs/workspace/connections.rst b/docs/workspace/catalog/connections.rst similarity index 100% rename from docs/workspace/connections.rst rename to docs/workspace/catalog/connections.rst diff --git a/docs/workspace/external_locations.rst b/docs/workspace/catalog/external_locations.rst similarity index 100% rename from docs/workspace/external_locations.rst rename to docs/workspace/catalog/external_locations.rst diff --git a/docs/workspace/functions.rst b/docs/workspace/catalog/functions.rst similarity index 100% rename from docs/workspace/functions.rst rename to docs/workspace/catalog/functions.rst diff --git a/docs/workspace/grants.rst b/docs/workspace/catalog/grants.rst similarity index 100% rename from docs/workspace/grants.rst rename to docs/workspace/catalog/grants.rst diff --git a/docs/workspace/catalog/index.rst b/docs/workspace/catalog/index.rst new file mode 100644 index 000000000..b3b18dc2c --- /dev/null +++ b/docs/workspace/catalog/index.rst @@ -0,0 +1,25 @@ + +Unity Catalog +============= + +Configure data governance with Unity Catalog for metastores, catalogs, schemas, tables, external locations, and storage credentials + +.. toctree:: + :maxdepth: 1 + + artifact_allowlists + catalogs + connections + external_locations + functions + grants + metastores + model_versions + registered_models + schemas + storage_credentials + system_schemas + table_constraints + tables + volumes + workspace_bindings \ No newline at end of file diff --git a/docs/workspace/metastores.rst b/docs/workspace/catalog/metastores.rst similarity index 100% rename from docs/workspace/metastores.rst rename to docs/workspace/catalog/metastores.rst diff --git a/docs/workspace/model_versions.rst b/docs/workspace/catalog/model_versions.rst similarity index 100% rename from docs/workspace/model_versions.rst rename to docs/workspace/catalog/model_versions.rst diff --git a/docs/workspace/registered_models.rst b/docs/workspace/catalog/registered_models.rst similarity index 100% rename from docs/workspace/registered_models.rst rename to docs/workspace/catalog/registered_models.rst diff --git a/docs/workspace/schemas.rst b/docs/workspace/catalog/schemas.rst similarity index 100% rename from docs/workspace/schemas.rst rename to docs/workspace/catalog/schemas.rst diff --git a/docs/workspace/storage_credentials.rst b/docs/workspace/catalog/storage_credentials.rst similarity index 100% rename from docs/workspace/storage_credentials.rst rename to docs/workspace/catalog/storage_credentials.rst diff --git a/docs/workspace/system_schemas.rst b/docs/workspace/catalog/system_schemas.rst similarity index 100% rename from docs/workspace/system_schemas.rst rename to docs/workspace/catalog/system_schemas.rst diff --git a/docs/workspace/table_constraints.rst b/docs/workspace/catalog/table_constraints.rst similarity index 100% rename from docs/workspace/table_constraints.rst rename to docs/workspace/catalog/table_constraints.rst diff --git a/docs/workspace/tables.rst b/docs/workspace/catalog/tables.rst similarity index 100% rename from docs/workspace/tables.rst rename to docs/workspace/catalog/tables.rst diff --git a/docs/workspace/volumes.rst b/docs/workspace/catalog/volumes.rst similarity index 100% rename from docs/workspace/volumes.rst rename to docs/workspace/catalog/volumes.rst diff --git a/docs/workspace/workspace_bindings.rst b/docs/workspace/catalog/workspace_bindings.rst similarity index 100% rename from docs/workspace/workspace_bindings.rst rename to docs/workspace/catalog/workspace_bindings.rst diff --git a/docs/workspace/cluster_policies.rst b/docs/workspace/compute/cluster_policies.rst similarity index 100% rename from docs/workspace/cluster_policies.rst rename to docs/workspace/compute/cluster_policies.rst diff --git a/docs/workspace/clusters.rst b/docs/workspace/compute/clusters.rst similarity index 100% rename from docs/workspace/clusters.rst rename to docs/workspace/compute/clusters.rst diff --git a/docs/workspace/command_execution.rst b/docs/workspace/compute/command_execution.rst similarity index 100% rename from docs/workspace/command_execution.rst rename to docs/workspace/compute/command_execution.rst diff --git a/docs/workspace/global_init_scripts.rst b/docs/workspace/compute/global_init_scripts.rst similarity index 100% rename from docs/workspace/global_init_scripts.rst rename to docs/workspace/compute/global_init_scripts.rst diff --git a/docs/workspace/compute/index.rst b/docs/workspace/compute/index.rst new file mode 100644 index 000000000..b13a21610 --- /dev/null +++ b/docs/workspace/compute/index.rst @@ -0,0 +1,17 @@ + +Compute +======= + +Use and configure compute for Databricks + +.. toctree:: + :maxdepth: 1 + + cluster_policies + clusters + command_execution + global_init_scripts + instance_pools + instance_profiles + libraries + policy_families \ No newline at end of file diff --git a/docs/workspace/instance_pools.rst b/docs/workspace/compute/instance_pools.rst similarity index 100% rename from docs/workspace/instance_pools.rst rename to docs/workspace/compute/instance_pools.rst diff --git a/docs/workspace/instance_profiles.rst b/docs/workspace/compute/instance_profiles.rst similarity index 100% rename from docs/workspace/instance_profiles.rst rename to docs/workspace/compute/instance_profiles.rst diff --git a/docs/workspace/libraries.rst b/docs/workspace/compute/libraries.rst similarity index 100% rename from docs/workspace/libraries.rst rename to docs/workspace/compute/libraries.rst diff --git a/docs/workspace/policy_families.rst b/docs/workspace/compute/policy_families.rst similarity index 100% rename from docs/workspace/policy_families.rst rename to docs/workspace/compute/policy_families.rst diff --git a/docs/workspace/workspace-dashboards.rst b/docs/workspace/dashboards/index.rst similarity index 70% rename from docs/workspace/workspace-dashboards.rst rename to docs/workspace/dashboards/index.rst index 2d325992d..756c9b549 100644 --- a/docs/workspace/workspace-dashboards.rst +++ b/docs/workspace/dashboards/index.rst @@ -5,6 +5,6 @@ Dashboards Manage Lakeview dashboards .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - lakeview \ No newline at end of file + lakeview \ No newline at end of file diff --git a/docs/workspace/lakeview.rst b/docs/workspace/dashboards/lakeview.rst similarity index 100% rename from docs/workspace/lakeview.rst rename to docs/workspace/dashboards/lakeview.rst diff --git a/docs/workspace/dbfs.rst b/docs/workspace/files/dbfs.rst similarity index 100% rename from docs/workspace/dbfs.rst rename to docs/workspace/files/dbfs.rst diff --git a/docs/workspace/workspace-files.rst b/docs/workspace/files/index.rst similarity index 82% rename from docs/workspace/workspace-files.rst rename to docs/workspace/files/index.rst index 88530a6b8..b2276ad6b 100644 --- a/docs/workspace/workspace-files.rst +++ b/docs/workspace/files/index.rst @@ -5,6 +5,6 @@ File Management Manage files on Databricks in a filesystem-like interface .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - dbfs \ No newline at end of file + dbfs \ No newline at end of file diff --git a/docs/workspace/account_access_control_proxy.rst b/docs/workspace/iam/account_access_control_proxy.rst similarity index 100% rename from docs/workspace/account_access_control_proxy.rst rename to docs/workspace/iam/account_access_control_proxy.rst diff --git a/docs/workspace/current_user.rst b/docs/workspace/iam/current_user.rst similarity index 100% rename from docs/workspace/current_user.rst rename to docs/workspace/iam/current_user.rst diff --git a/docs/workspace/groups.rst b/docs/workspace/iam/groups.rst similarity index 100% rename from docs/workspace/groups.rst rename to docs/workspace/iam/groups.rst diff --git a/docs/workspace/workspace-iam.rst b/docs/workspace/iam/index.rst similarity index 58% rename from docs/workspace/workspace-iam.rst rename to docs/workspace/iam/index.rst index 021ff539d..11e9318f9 100644 --- a/docs/workspace/workspace-iam.rst +++ b/docs/workspace/iam/index.rst @@ -5,11 +5,11 @@ Identity and Access Management Manage users, service principals, groups and their permissions in Accounts and Workspaces .. toctree:: - :maxdepth: 1 - - account_access_control_proxy - current_user - groups - permissions - service_principals - users \ No newline at end of file + :maxdepth: 1 + + account_access_control_proxy + current_user + groups + permissions + service_principals + users \ No newline at end of file diff --git a/docs/workspace/permissions.rst b/docs/workspace/iam/permissions.rst similarity index 100% rename from docs/workspace/permissions.rst rename to docs/workspace/iam/permissions.rst diff --git a/docs/workspace/service_principals.rst b/docs/workspace/iam/service_principals.rst similarity index 100% rename from docs/workspace/service_principals.rst rename to docs/workspace/iam/service_principals.rst diff --git a/docs/workspace/users.rst b/docs/workspace/iam/users.rst similarity index 100% rename from docs/workspace/users.rst rename to docs/workspace/iam/users.rst diff --git a/docs/workspace/index.rst b/docs/workspace/index.rst index f9a223efe..de76f7c5f 100644 --- a/docs/workspace/index.rst +++ b/docs/workspace/index.rst @@ -5,19 +5,19 @@ Workspace APIs These APIs are available from WorkspaceClient .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - workspace-workspace - workspace-compute - workspace-jobs - workspace-pipelines - workspace-files - workspace-ml - workspace-serving - workspace-iam - workspace-sql - workspace-catalog - workspace-sharing - workspace-settings - workspace-vectorsearch - workspace-dashboards \ No newline at end of file + workspace/index + compute/index + jobs/index + pipelines/index + files/index + ml/index + serving/index + iam/index + sql/index + catalog/index + sharing/index + settings/index + vectorsearch/index + dashboards/index \ No newline at end of file diff --git a/docs/workspace/workspace-jobs.rst b/docs/workspace/jobs/index.rst similarity index 76% rename from docs/workspace/workspace-jobs.rst rename to docs/workspace/jobs/index.rst index a1a53a955..a8f242ea2 100644 --- a/docs/workspace/workspace-jobs.rst +++ b/docs/workspace/jobs/index.rst @@ -5,6 +5,6 @@ Jobs Schedule automated jobs on Databricks Workspaces .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - jobs \ No newline at end of file + jobs \ No newline at end of file diff --git a/docs/workspace/jobs.rst b/docs/workspace/jobs/jobs.rst similarity index 100% rename from docs/workspace/jobs.rst rename to docs/workspace/jobs/jobs.rst diff --git a/docs/workspace/experiments.rst b/docs/workspace/ml/experiments.rst similarity index 100% rename from docs/workspace/experiments.rst rename to docs/workspace/ml/experiments.rst diff --git a/docs/workspace/workspace-ml.rst b/docs/workspace/ml/index.rst similarity index 72% rename from docs/workspace/workspace-ml.rst rename to docs/workspace/ml/index.rst index e701cfd1d..1a713eb57 100644 --- a/docs/workspace/workspace-ml.rst +++ b/docs/workspace/ml/index.rst @@ -5,7 +5,7 @@ Machine Learning Create and manage experiments, features, and other machine learning artifacts .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - experiments - model_registry \ No newline at end of file + experiments + model_registry \ No newline at end of file diff --git a/docs/workspace/model_registry.rst b/docs/workspace/ml/model_registry.rst similarity index 100% rename from docs/workspace/model_registry.rst rename to docs/workspace/ml/model_registry.rst diff --git a/docs/workspace/workspace-pipelines.rst b/docs/workspace/pipelines/index.rst similarity index 80% rename from docs/workspace/workspace-pipelines.rst rename to docs/workspace/pipelines/index.rst index 8213f87ef..83aaafe99 100644 --- a/docs/workspace/workspace-pipelines.rst +++ b/docs/workspace/pipelines/index.rst @@ -5,6 +5,6 @@ Delta Live Tables Manage pipelines, runs, and other Delta Live Table resources .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - pipelines \ No newline at end of file + pipelines \ No newline at end of file diff --git a/docs/workspace/pipelines.rst b/docs/workspace/pipelines/pipelines.rst similarity index 100% rename from docs/workspace/pipelines.rst rename to docs/workspace/pipelines/pipelines.rst diff --git a/docs/workspace/apps.rst b/docs/workspace/serving/apps.rst similarity index 100% rename from docs/workspace/apps.rst rename to docs/workspace/serving/apps.rst diff --git a/docs/workspace/workspace-serving.rst b/docs/workspace/serving/index.rst similarity index 69% rename from docs/workspace/workspace-serving.rst rename to docs/workspace/serving/index.rst index 754822d18..ce3d216ff 100644 --- a/docs/workspace/workspace-serving.rst +++ b/docs/workspace/serving/index.rst @@ -5,7 +5,7 @@ Real-time Serving Use real-time inference for machine learning .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - apps - serving_endpoints \ No newline at end of file + apps + serving_endpoints \ No newline at end of file diff --git a/docs/workspace/serving_endpoints.rst b/docs/workspace/serving/serving_endpoints.rst similarity index 100% rename from docs/workspace/serving_endpoints.rst rename to docs/workspace/serving/serving_endpoints.rst diff --git a/docs/workspace/credentials_manager.rst b/docs/workspace/settings/credentials_manager.rst similarity index 100% rename from docs/workspace/credentials_manager.rst rename to docs/workspace/settings/credentials_manager.rst diff --git a/docs/workspace/settings/index.rst b/docs/workspace/settings/index.rst new file mode 100644 index 000000000..a524f671d --- /dev/null +++ b/docs/workspace/settings/index.rst @@ -0,0 +1,15 @@ + +Settings +======== + +Manage security settings for Accounts and Workspaces + +.. toctree:: + :maxdepth: 1 + + credentials_manager + ip_access_lists + settings + token_management + tokens + workspace_conf \ No newline at end of file diff --git a/docs/workspace/ip_access_lists.rst b/docs/workspace/settings/ip_access_lists.rst similarity index 100% rename from docs/workspace/ip_access_lists.rst rename to docs/workspace/settings/ip_access_lists.rst diff --git a/docs/workspace/settings.rst b/docs/workspace/settings/settings.rst similarity index 100% rename from docs/workspace/settings.rst rename to docs/workspace/settings/settings.rst diff --git a/docs/workspace/token_management.rst b/docs/workspace/settings/token_management.rst similarity index 100% rename from docs/workspace/token_management.rst rename to docs/workspace/settings/token_management.rst diff --git a/docs/workspace/tokens.rst b/docs/workspace/settings/tokens.rst similarity index 100% rename from docs/workspace/tokens.rst rename to docs/workspace/settings/tokens.rst diff --git a/docs/workspace/workspace_conf.rst b/docs/workspace/settings/workspace_conf.rst similarity index 100% rename from docs/workspace/workspace_conf.rst rename to docs/workspace/settings/workspace_conf.rst diff --git a/docs/workspace/clean_rooms.rst b/docs/workspace/sharing/clean_rooms.rst similarity index 100% rename from docs/workspace/clean_rooms.rst rename to docs/workspace/sharing/clean_rooms.rst diff --git a/docs/workspace/workspace-sharing.rst b/docs/workspace/sharing/index.rst similarity index 57% rename from docs/workspace/workspace-sharing.rst rename to docs/workspace/sharing/index.rst index 5ba08d21b..e012eb548 100644 --- a/docs/workspace/workspace-sharing.rst +++ b/docs/workspace/sharing/index.rst @@ -5,10 +5,10 @@ Delta Sharing Configure data sharing with Unity Catalog for providers, recipients, and shares .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - clean_rooms - providers - recipient_activation - recipients - shares \ No newline at end of file + clean_rooms + providers + recipient_activation + recipients + shares \ No newline at end of file diff --git a/docs/workspace/providers.rst b/docs/workspace/sharing/providers.rst similarity index 100% rename from docs/workspace/providers.rst rename to docs/workspace/sharing/providers.rst diff --git a/docs/workspace/recipient_activation.rst b/docs/workspace/sharing/recipient_activation.rst similarity index 100% rename from docs/workspace/recipient_activation.rst rename to docs/workspace/sharing/recipient_activation.rst diff --git a/docs/workspace/recipients.rst b/docs/workspace/sharing/recipients.rst similarity index 100% rename from docs/workspace/recipients.rst rename to docs/workspace/sharing/recipients.rst diff --git a/docs/workspace/shares.rst b/docs/workspace/sharing/shares.rst similarity index 100% rename from docs/workspace/shares.rst rename to docs/workspace/sharing/shares.rst diff --git a/docs/workspace/alerts.rst b/docs/workspace/sql/alerts.rst similarity index 100% rename from docs/workspace/alerts.rst rename to docs/workspace/sql/alerts.rst diff --git a/docs/workspace/dashboard_widgets.rst b/docs/workspace/sql/dashboard_widgets.rst similarity index 100% rename from docs/workspace/dashboard_widgets.rst rename to docs/workspace/sql/dashboard_widgets.rst diff --git a/docs/workspace/dashboards.rst b/docs/workspace/sql/dashboards.rst similarity index 100% rename from docs/workspace/dashboards.rst rename to docs/workspace/sql/dashboards.rst diff --git a/docs/workspace/data_sources.rst b/docs/workspace/sql/data_sources.rst similarity index 100% rename from docs/workspace/data_sources.rst rename to docs/workspace/sql/data_sources.rst diff --git a/docs/workspace/dbsql_permissions.rst b/docs/workspace/sql/dbsql_permissions.rst similarity index 100% rename from docs/workspace/dbsql_permissions.rst rename to docs/workspace/sql/dbsql_permissions.rst diff --git a/docs/workspace/sql/index.rst b/docs/workspace/sql/index.rst new file mode 100644 index 000000000..397de5c72 --- /dev/null +++ b/docs/workspace/sql/index.rst @@ -0,0 +1,19 @@ + +Databricks SQL +============== + +Manage Databricks SQL assets, including warehouses, dashboards, queries and query history, and alerts + +.. toctree:: + :maxdepth: 1 + + alerts + dashboard_widgets + dashboards + data_sources + dbsql_permissions + queries + query_history + query_visualizations + statement_execution + warehouses \ No newline at end of file diff --git a/docs/workspace/queries.rst b/docs/workspace/sql/queries.rst similarity index 100% rename from docs/workspace/queries.rst rename to docs/workspace/sql/queries.rst diff --git a/docs/workspace/query_history.rst b/docs/workspace/sql/query_history.rst similarity index 100% rename from docs/workspace/query_history.rst rename to docs/workspace/sql/query_history.rst diff --git a/docs/workspace/query_visualizations.rst b/docs/workspace/sql/query_visualizations.rst similarity index 100% rename from docs/workspace/query_visualizations.rst rename to docs/workspace/sql/query_visualizations.rst diff --git a/docs/workspace/statement_execution.rst b/docs/workspace/sql/statement_execution.rst similarity index 100% rename from docs/workspace/statement_execution.rst rename to docs/workspace/sql/statement_execution.rst diff --git a/docs/workspace/warehouses.rst b/docs/workspace/sql/warehouses.rst similarity index 100% rename from docs/workspace/warehouses.rst rename to docs/workspace/sql/warehouses.rst diff --git a/docs/workspace/workspace-vectorsearch.rst b/docs/workspace/vectorsearch/index.rst similarity index 55% rename from docs/workspace/workspace-vectorsearch.rst rename to docs/workspace/vectorsearch/index.rst index ea93d2b65..b4af05509 100644 --- a/docs/workspace/workspace-vectorsearch.rst +++ b/docs/workspace/vectorsearch/index.rst @@ -5,7 +5,7 @@ Vector Search Create and query Vector Search indexes .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - vector_search_endpoints - vector_search_indexes \ No newline at end of file + vector_search_endpoints + vector_search_indexes \ No newline at end of file diff --git a/docs/workspace/vector_search_endpoints.rst b/docs/workspace/vectorsearch/vector_search_endpoints.rst similarity index 100% rename from docs/workspace/vector_search_endpoints.rst rename to docs/workspace/vectorsearch/vector_search_endpoints.rst diff --git a/docs/workspace/vector_search_indexes.rst b/docs/workspace/vectorsearch/vector_search_indexes.rst similarity index 100% rename from docs/workspace/vector_search_indexes.rst rename to docs/workspace/vectorsearch/vector_search_indexes.rst diff --git a/docs/workspace/workspace-catalog.rst b/docs/workspace/workspace-catalog.rst deleted file mode 100644 index 9a0342e31..000000000 --- a/docs/workspace/workspace-catalog.rst +++ /dev/null @@ -1,25 +0,0 @@ - -Unity Catalog -============= - -Configure data governance with Unity Catalog for metastores, catalogs, schemas, tables, external locations, and storage credentials - -.. toctree:: - :maxdepth: 1 - - artifact_allowlists - catalogs - connections - external_locations - functions - grants - metastores - model_versions - registered_models - schemas - storage_credentials - system_schemas - table_constraints - tables - volumes - workspace_bindings \ No newline at end of file diff --git a/docs/workspace/workspace-compute.rst b/docs/workspace/workspace-compute.rst deleted file mode 100644 index cbb4bb833..000000000 --- a/docs/workspace/workspace-compute.rst +++ /dev/null @@ -1,17 +0,0 @@ - -Compute -======= - -Use and configure compute for Databricks - -.. toctree:: - :maxdepth: 1 - - cluster_policies - clusters - command_execution - global_init_scripts - instance_pools - instance_profiles - libraries - policy_families \ No newline at end of file diff --git a/docs/workspace/workspace-settings.rst b/docs/workspace/workspace-settings.rst deleted file mode 100644 index ffe66b24a..000000000 --- a/docs/workspace/workspace-settings.rst +++ /dev/null @@ -1,15 +0,0 @@ - -Settings -======== - -Manage security settings for Accounts and Workspaces - -.. toctree:: - :maxdepth: 1 - - credentials_manager - ip_access_lists - settings - token_management - tokens - workspace_conf \ No newline at end of file diff --git a/docs/workspace/workspace-sql.rst b/docs/workspace/workspace-sql.rst deleted file mode 100644 index 3d1053f4a..000000000 --- a/docs/workspace/workspace-sql.rst +++ /dev/null @@ -1,19 +0,0 @@ - -Databricks SQL -============== - -Manage Databricks SQL assets, including warehouses, dashboards, queries and query history, and alerts - -.. toctree:: - :maxdepth: 1 - - alerts - dashboard_widgets - dashboards - data_sources - dbsql_permissions - queries - query_history - query_visualizations - statement_execution - warehouses \ No newline at end of file diff --git a/docs/workspace/git_credentials.rst b/docs/workspace/workspace/git_credentials.rst similarity index 100% rename from docs/workspace/git_credentials.rst rename to docs/workspace/workspace/git_credentials.rst diff --git a/docs/workspace/workspace-workspace.rst b/docs/workspace/workspace/index.rst similarity index 64% rename from docs/workspace/workspace-workspace.rst rename to docs/workspace/workspace/index.rst index 4e8f8a419..c52ba1acb 100644 --- a/docs/workspace/workspace-workspace.rst +++ b/docs/workspace/workspace/index.rst @@ -5,9 +5,9 @@ Workspace Manage workspace-level entities that include notebooks, Git checkouts, and secrets .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - git_credentials - repos - secrets - workspace \ No newline at end of file + git_credentials + repos + secrets + workspace \ No newline at end of file diff --git a/docs/workspace/repos.rst b/docs/workspace/workspace/repos.rst similarity index 100% rename from docs/workspace/repos.rst rename to docs/workspace/workspace/repos.rst diff --git a/docs/workspace/secrets.rst b/docs/workspace/workspace/secrets.rst similarity index 100% rename from docs/workspace/secrets.rst rename to docs/workspace/workspace/secrets.rst diff --git a/docs/workspace/workspace.rst b/docs/workspace/workspace/workspace.rst similarity index 100% rename from docs/workspace/workspace.rst rename to docs/workspace/workspace/workspace.rst