Skip to content

Commit 4fa7be4

Browse files
author
guyplusplus
committed
More TODO
1 parent a864c81 commit 4fa7be4

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
/releases
1+
/releases
2+
/vis_type_custom_form_filter_accounts/target

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,17 +73,17 @@ $ sudo apt update
7373
$ sudo apt install yarn
7474
```
7575

76-
6. Download Kibana source code and select the target version (v7.6.2, v7.0.0, etc.). `kibana` is the top directory.
76+
6. Download Kibana source code and select the target version (v7.6.2, v7.0.0, etc.). `kibana` is the top directory
7777

7878
```
7979
$ git clone https://github.com/elastic/kibana.git
8080
$ cd kibana
8181
$ git checkout v7.6.2
8282
```
8383

84-
7. Copy the source code with modified name inside the `kibana/plugins` directory.
84+
7. Copy the source code with modified name inside the `kibana/plugins` directory
8585

86-
8. Start Kibana in development mode, ensuring only OSS (Open Source) features are used
86+
8. Start Kibana in development mode, ensuring only OSS (Open Source Software) features are used
8787

8888
```
8989
$ cd kibana
@@ -99,17 +99,17 @@ $ echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf
9999
$ sudo sysctl -p
100100
```
101101

102-
10. If you have problem to start Kibana 7.7.0 (from Git. For some reason it thinks it is already in version 8.0.0) with ElasticSearch 7.7.0, add this line in `config/kibana.yml` config file. When upgrading from 7.6 to 7.7 I had to delete all indexes `curl -XDELETE localhost:9200/*`.
102+
10. If you have problem to start Kibana 7.7.0 (from Git. For some reason it thinks it is already in version 8.0.0) with ElasticSearch 7.7.0, add this line in `config/kibana.yml` config file. When upgrading from 7.6 to 7.7 I had to delete all indexes `curl -XDELETE localhost:9200/*`
103103

104104
```
105105
elasticsearch.ignoreVersionMismatch: true
106106
```
107107

108-
## Creating the actual form (step 7)
108+
## Creating the actual form (step 7) for your own usecase
109109

110-
The current plugin name is based on accounts data. Simply perform a search replace in filenames and in the source code, respecting letter capitalization.
110+
The current plugin name is based on accounts test data. Simply perform a search replace in filenames and in the source code, respecting letter capitalization.
111111

112-
The form itself is contained in the [controller file](https://github.com/guyplusplus/Kibana-Plugin-Custom-Form-Filter-Visualization/blob/master/vis_type_custom_form_filter_accounts/public/custom_form_filter_accounts_vis_controller.tsx). An [option tab](https://github.com/guyplusplus/Kibana-Plugin-Custom-Form-Filter-Visualization/blob/master/vis_type_custom_form_filter_accounts/public/custom_form_filter_accounts_options.tsx) is also possible.
112+
The form itself is contained in the [controller file](https://github.com/guyplusplus/Kibana-Plugin-Custom-Form-Filter-Visualization/blob/master/vis_type_custom_form_filter_accounts/public/custom_form_filter_accounts_vis_controller.tsx) file. An [option tab](https://github.com/guyplusplus/Kibana-Plugin-Custom-Form-Filter-Visualization/blob/master/vis_type_custom_form_filter_accounts/public/custom_form_filter_accounts_options.tsx) is also possible, actually one or more.
113113

114114
The form code looks like this and is very simple to modify, based on EUI React components.
115115
* [Documentation](https://elastic.github.io/eui/#/)
@@ -132,9 +132,9 @@ The form code looks like this and is very simple to modify, based on EUI React c
132132
</div>
133133
```
134134

135-
## Creating the plugin zip file
135+
## Packaging the plugin as a zip file
136136

137-
Simply add the plugin directory inside a kibana folder and zip the file. Do not include the `kibana/target` directory. The zip structure is
137+
Simply add the plugin directory inside a `kibana` folder and zip the file. Do not include the `kibana/target` directory. The zip structure is
138138

139139
```
140140
my-plugin_7.7.0.zip
@@ -165,8 +165,10 @@ $ rm -rf /usr/share/kibana/optimize/bundles
165165

166166
## Project TODO List
167167

168-
- [ ] Create form content (i.e. dropdown, slider) based on actual data
168+
- [ ] Create form content (i.e. dropdown, slider) with actual data
169169
- [ ] Create a script to replace 'accounts' in filenames and file content
170+
- [ ] Add internationalization example
171+
- [ ] Create test script
170172
- [ ] Create own plugin icon
171173

172174

0 commit comments

Comments
 (0)