Skip to content

Commit

Permalink
docs(sense-cli): add explanation to nebula sense options (#638)
Browse files Browse the repository at this point in the history
* fix: get extension definition from chart object

* fix: ext from argument should override ext from the chart

* feat: update build

* refactor: remove console.error

* refactor: add empty line

* feat: switch --partial option to default and add --legacy as an option

* refactor: update yarn option

* refactor: remove hidden from legacy option

* docs(sense-cli): add explanation to nebula sense options

* docs(sense-cli): add explanation to nebula sense meta

* docs(sense-cli-sense): update links

Co-authored-by: quanho <quan.ho@qlik.com>
  • Loading branch information
LiKang6688 and quanho committed Aug 30, 2021
1 parent 6db4d7f commit 6b4910e
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions commands/sense/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,13 @@ Options:
--output Destination directory [string] [default: "<name>-ext"]
--minify Minify and uglify code [boolean] [default: true]
--sourcemap Generate sourcemaps [boolean] [default: false]
--legacy Generate legacy extension [boolean] [default: false]
-h, --help Show help [boolean]
```

### Extension
## Extension

### EXT

You can provide some additional information as part of the Qlik Sense Extension API by creating a separate file for the extension info and providing it as argument to `--ext`:

Expand All @@ -45,8 +48,6 @@ export default {
nebula sense --ext def.js
```

The command generates all required files into the specified `--output` folder. You can the zip the folder and upload it as an extension on [Qlik Sense Enterprise for Windows](https://help.qlik.com/en-US/sense-developer/April2020/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm) or [Qlik Sense Enterprise on Kubernetes](https://help.qlik.com/en-US/sense-admin/April2020/Subsystems/DeployAdministerQSE/Content/Sense_DeployAdminister/QSEoK/Administer_QSEoK/mc-extensions.htm)

### Meta

You can add more meta about the extension by providing a `.json` formatted file with `--meta`:
Expand All @@ -62,4 +63,24 @@ You can add more meta about the extension by providing a `.json` formatted file
nebula sense --meta meta.json
```

The meta data will be ended up in the `.qext` file used by the Qlik Sense.

The rest of the required information is populated automatically based on the content in `package.json`.

### Output

Generate all required files into the specified `--output` folder called sn-table-ext:

```bash
nebula sense --output sn-table-ext
```

You can upload that folder as an extension on [Qlik Sense Enterprise for Windows](https://help.qlik.com/en-US/sense-developer/August2021/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm) or [SaaS editions of Qlik Sense](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Admin/mc-extensions.htm)

### Legacy

Explicitly declaring legacy to generate legacy extension to run in old Qlik Sense which does not support nebula supernova:

```bash
nebula sense --legacy
```

0 comments on commit 6b4910e

Please sign in to comment.