Skip to content

Commit 292cbfa

Browse files
authored
Make sure README doesn't look broken in the VSCode extension view (#194)
External link are not resolved properly. Comment out until the repo is public. ![Screenshot 2022-11-10 at 15 57 17](https://user-images.githubusercontent.com/40952/201126137-b1c1dafb-2d5a-4ebe-ab36-fa68a80d60b8.png)
1 parent 1e9212a commit 292cbfa

File tree

3 files changed

+16
-11
lines changed

3 files changed

+16
-11
lines changed

packages/databricks-vscode/README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
1-
# Databricks extension for VSCode
1+
# Databricks extension for Visual Studio Code
22

3-
| System | Status |
4-
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5-
| Build ([main branch](https://github.com/databricks/databricks-vscode/commits/main)) | [![GitHub CI Status](https://github.com/databricks/databricks-vscode/actions/workflows/push.yml/badge.svg?branch=main)](https://github.com/databricks/databricks-vscode/actions/workflows/push.yml) |
6-
| [Marketplace](https://marketplace.visualstudio.com/items?itemName=databricks.databricks-vscode) | [![Marketplace Version](https://img.shields.io/vscode-marketplace/v/databricks.databricks-vscode.svg) ![Marketplace Downloads](https://img.shields.io/vscode-marketplace/d/databricks.databricks-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=databricks.databricks-vscode) |
7-
8-
The Databricks extension for VSCode allows you to develop for the Databricks Lakehouse platform from VSCode.
3+
The Databricks extension for VS Code allows you to develop for the Databricks Lakehouse platform from VS Code.
94

105
The extension is available from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/itemdetails?itemName=databricks.databricks-vscode).
116

@@ -17,7 +12,11 @@ This is an open source project because we want you to be involved. We love issue
1712
- Run Python files on a Databricks cluster
1813
- Run notebooks and Python files as Workflows
1914

15+
<!--
16+
Comment out until the repo is public so the image can be loaded by the marketplace
17+
2018
![run](./images/run.gif)
19+
-->
2120

2221
## Requirements
2322

@@ -30,17 +29,23 @@ In order to use this extension you need acceess to a Databricks workspace:
3029
3. Access to an interactive cluster or permissions to create a cluster
3130
4. Permissions to create Databricks repos
3231

32+
<!--
33+
34+
Comment out until the repo is public so the image can be loaded by the marketplace
35+
3336
## Documentation
3437
3538
- The [Quick Start Guide](README.quickstart.md) provides an overview
3639
of common features.
3740
- <mark>The [User Guide](https://docs.databricks.com/)
3841
contains comprehesive documentation about the Databricks extension. (TODO: Link not available yet)</mark>
3942
43+
-->
44+
4045
## Release Notes
4146

4247
### 0.0.1
4348

44-
Preview version of the VSCode extension for Databricks
49+
Preview version of the VS Code extension for Databricks
4550

4651
**Happy Coding!**

packages/databricks-vscode/README.quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Databricks Extension for VSCode
1+
# Databricks Extension for Visual Studio Code
22

3-
The Databricks extension for VSCode allows you to develop for the Databricks Lakehouse platform from VSCode.
3+
The Databricks extension for VS Code allows you to develop for the Databricks Lakehouse platform from VS Code.
44

55
# Features
66

packages/databricks-vscode/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -578,4 +578,4 @@
578578
],
579579
"report-dir": "coverage"
580580
}
581-
}
581+
}

0 commit comments

Comments
 (0)