Skip to content

Commit 01ec548

Browse files
committed
change command names + update readme and install message
1 parent 029d490 commit 01ec548

File tree

4 files changed

+22
-16
lines changed

4 files changed

+22
-16
lines changed

Dataiku.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ def browse_instances(window, type):
9898
})
9999

100100
commands.append({
101-
"caption": "Edit DSS instances",
101+
"caption": "Configure DSS instances",
102102
"command": "open_file",
103103
"args": {
104104
"file": "${packages}/User/Dataiku.sublime-settings"

Default.sublime-commands

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
[
22
{
3-
"caption": "Dataiku: Browse DSS recipes",
3+
"caption": "Dataiku: Edit DSS recipes",
44
"command": "dataiku_instances_recipes"
55
},
66
{
7-
"caption": "Dataiku: Browse DSS plugins",
7+
"caption": "Dataiku: Edit DSS plugins",
88
"command": "dataiku_instances_plugins"
99
},
1010
{
11-
"caption": "Dataiku: Edit DSS instances",
11+
"caption": "Dataiku: Configure DSS instances",
1212
"command": "open_file",
1313
"args": {
1414
"file": "${packages}/User/Dataiku.sublime-settings"

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
DataikuSublimeText
22
==================
33

4-
Sublime Text plugin to edit [Dataiku DSS](https://www.dataiku.com/dss/) recipes remotely.
4+
Sublime Text plugin to edit [Dataiku DSS](https://www.dataiku.com/dss/) recipes and plugins remotely.
55

66
![Preview](https://raw.githubusercontent.com/jereze/DataikuSublimeText/master/preview.gif)
77

88
## Requirements
99

1010
* Sublime Text 3
11-
* Dataiku DSS 3.1 or further
11+
* Dataiku DSS 3.1 or further (4.0 for plugins edition)
1212
* Access to Dataiku DSS Public API (with a valid [API key](https://doc.dataiku.com/dss/latest/api/public/keys.html))
1313

1414
Note: From DSS 4.0, you have to generate a `Personal API key` on a User profile. Before, a `Global API key` was required.
@@ -17,11 +17,17 @@ Note: From DSS 4.0, you have to generate a `Personal API key` on a User profile.
1717

1818
In Sublime Text, once installed with [Package Control](https://packagecontrol.io/), open the Command Palette (`ctrl+shift+p` on Win/Linux, `cmd+shift+p` on MacOS) and type `dataiku`. You will have two options:
1919

20-
* Edit DSS instances: use this to configure the instances you can edit remotely.
21-
* Browse DSS instances: use this to choose the DSS instance you want to work with, and then the recipe you want to edit.
20+
* __Configure DSS instances__: use this to configure the instances you can edit remotely.
21+
* __Edit DSS recipes__: use this to choose a recipe to open in the editor. You will have to select first a DSS instance if more than one are available.
22+
* __Edit DSS plugins__: use this to choose a plugin file to open in the editor. You will have to select first a DSS instance if more than one are available.
2223

23-
Find out more in the guide on Dataiku website.
24+
Find out more in the [guide](https://www.dataiku.com/learn/guide/tips/dataiku-dss-sublime-text.html) on Dataiku website.
2425

2526
## Need help?
2627

2728
Ask your question on [answers.dataiku.com](https://answers.dataiku.com). Or, [open an issue](https://github.com/jereze/DataikuSublimeText/issues).
29+
30+
## Contributors
31+
32+
* @jereze
33+
* @ThmsLa

messages/install.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Thanks for installing Dataiku plugin for Sublime Text!
2-
It allows you to edit Dataiku DSS recipes remotely.
2+
It allows you to edit Dataiku DSS recipes and plugins remotely.
33

44
Below are some quick notes to get you started with the plugin. Please see https://github.com/jereze/DataikuSublimeText for more information.
55

@@ -11,8 +11,8 @@ Below are some quick notes to get you started with the plugin. Please see https:
1111

1212
## Configuration:
1313

14-
Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and search for "Dataiku: Edit DSS instances".
15-
It opens a configuration files. Complete it with the following model:
14+
Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and search for "Dataiku: Configure DSS instances".
15+
It opens a configuration file. Complete it with the following model:
1616

1717
{
1818
"instances": [
@@ -30,10 +30,10 @@ It opens a configuration files. Complete it with the following model:
3030

3131
## Usage:
3232

33-
Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and search for "Dataiku: Browse DSS Instances".
34-
Then, navigate through the recipes, select one.
35-
It opens the recipe in a new tab.
36-
When saving, the recipe is saved on the Dataiku DSS instance via the API.
33+
Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and search for "Dataiku: Edit DSS recipes" or "Dataiku: Edit DSS plugins".
34+
Then, navigate through the recipes or plugins files, select one.
35+
It opens the item in a new tab.
36+
When saving, the item is saved on the Dataiku DSS instance via the API.
3737
You should close the tab as soon as you have finished editing, because the merge in case of conflicts is not handled.
3838

3939

0 commit comments

Comments
 (0)