Merge "updating generator and documentation"
diff --git a/docs/developer/gui_extensions.md b/docs/developer/gui_extensions.md
index 4bb6108..52bf7f7 100644
--- a/docs/developer/gui_extensions.md
+++ b/docs/developer/gui_extensions.md
@@ -35,11 +35,40 @@
extension folder.
-## Add an extension to a profile
+## Adding an extension to the build system
-To deploy your GUI extension with a cord profile you'll need to reference it in `platform-install/profile-manifests`.
+To deploy your GUI extension with a cord profile you'll need to reference it in `platform-install` and `build`.
+The following steps must be followed to ensure that your GUI extension builds correctly with XOS.
+
+### Adding the extension to `docker_images.yml`
+
+Open `cord/build/docker_images.yml`. Locate the section of the file with other GUI extensions, and add the following:
+
+```yaml
+- name: xosproject/gui-extension-sample
+ repo: sampleRepo # should match Gerrit repo name
+ path: "xos/gui" # path to find extension in the repo (i.e. sampleRepo/xos/gui/)
+```
+Please maintain ascending alphabetical order among the GUI extensions when inserting your own extension.
+
+### Adding the extension to the podconfig scenario
+
+Open the `config.yml` file of the podconfig scenario relevant to your GUI extension (e.g. cord, mock, local).
+Locate the section titled `docker_image_whitelist` and add your GUI extension.
+
+```yaml
+docker_image_whitelist:
+# ...other docker images...
+ - "xosproject/gui-extension-rcord"
+ - "xosproject/gui-extension-sample" # extension added in alphabetical order
+ - "xosproject/gui-extension-vtr"
+# ...more docker images...
+
+```
+
+### Adding the extension to the podconfig profile manifest
-Open the `profile-manifest` you're working on (eg: `profile_manifests/ecord-global.yml`) and locate `enabled_gui_extensions`.
+Open the `profile-manifest` relevant to the podconfig you're working on (eg: profile_manifests/frontend.yml) and locate `enabled_gui_extensions`.
It may appear in two forms, depending whether or not there are others loaded extensions:
```yaml
enabled_gui_extensions:
@@ -52,6 +81,8 @@
```
_NOTE: if it is not there, just create it._
+### Change conf export settings to match extension name
+
To add your extension, just add it to the list:
```yaml
enabled_gui_extensions:
diff --git a/generator-xos-gui-extension/README.md b/generator-xos-gui-extension/README.md
new file mode 100644
index 0000000..fb671d7
--- /dev/null
+++ b/generator-xos-gui-extension/README.md
@@ -0,0 +1,17 @@
+#generator-xos-gui-extension
+
+## About
+This is a Yeoman generator intended to aid with the development of new XOS GUI Extensions. It generates a new GUI extension
+with only one component.
+
+## Installation
+Run the following command in this directory:
+```bash
+npm link
+```
+
+## Running the generator
+Run the following command in any directory and follow the prompts.
+```bash
+yo xos-gui-extension
+```
\ No newline at end of file
diff --git a/generator-xos-gui-extension/generators/README.md b/generator-xos-gui-extension/generators/README.md
deleted file mode 100644
index c13ead2..0000000
--- a/generator-xos-gui-extension/generators/README.md
+++ /dev/null
@@ -1,11 +0,0 @@
-#generator-xos-gui-extension
-
-## About
-This is a Yeoman generator intended to aid with the development of new XOS GUI Extensions. It generates a new GUI extension
-with only one component.
-
-## Installation
-Run the following command in this directory and follow the prompts.
-```
-yo xos-gui-extension
-```
\ No newline at end of file
diff --git a/generator-xos-gui-extension/generators/templates/conf/webpack-dist.conf.js b/generator-xos-gui-extension/generators/templates/conf/webpack-dist.conf.js
index c870043..5f924fb 100755
--- a/generator-xos-gui-extension/generators/templates/conf/webpack-dist.conf.js
+++ b/generator-xos-gui-extension/generators/templates/conf/webpack-dist.conf.js
@@ -105,7 +105,10 @@
'.web.js',
'.js',
'.ts'
- ]
+ ],
+ alias: {
+ "ngprogress": path.resolve(__dirname, '../node_modules/ngprogress/build/ngProgress.js')
+ }
},
entry: {
app: `./${conf.path.src('index')}`,
diff --git a/generator-xos-gui-extension/generators/templates/conf/webpack-test.conf.js b/generator-xos-gui-extension/generators/templates/conf/webpack-test.conf.js
index c0115ab..04f9e4c 100755
--- a/generator-xos-gui-extension/generators/templates/conf/webpack-test.conf.js
+++ b/generator-xos-gui-extension/generators/templates/conf/webpack-test.conf.js
@@ -73,7 +73,10 @@
'.web.js',
'.js',
'.ts'
- ]
+ ],
+ alias: {
+ "ngprogress": path.resolve(__dirname, '../node_modules/ngprogress/build/ngProgress.js')
+ }
},
ts: {
configFileName: 'tsconfig.json'
diff --git a/generator-xos-gui-extension/generators/templates/conf/webpack.conf.js b/generator-xos-gui-extension/generators/templates/conf/webpack.conf.js
index d70e771..f0dbc51 100755
--- a/generator-xos-gui-extension/generators/templates/conf/webpack.conf.js
+++ b/generator-xos-gui-extension/generators/templates/conf/webpack.conf.js
@@ -99,7 +99,10 @@
'.web.js',
'.js',
'.ts'
- ]
+ ],
+ alias: {
+ "ngprogress": path.resolve(__dirname, '../node_modules/ngprogress/build/ngProgress.js')
+ }
},
entry: `./${conf.path.src('index')}`,
ts: {
diff --git a/generator-xos-gui-extension/generators/templates/package.json b/generator-xos-gui-extension/generators/templates/package.json
index 32a0676..b56f74e 100644
--- a/generator-xos-gui-extension/generators/templates/package.json
+++ b/generator-xos-gui-extension/generators/templates/package.json
@@ -1,5 +1,5 @@
{
- "version": "3.0.0",
+ "version": "4.0.0",
"dependencies": {
"angular": "1.6.3",
"angular-animate": "1.6.3",