Skip to content
This repository was archived by the owner on Jan 22, 2024. It is now read-only.

Commit 92a67a5

Browse files
author
Jonathan Booth
authored
Updated Readme for changes to buttons in Dashboard
1 parent f3ebb7b commit 92a67a5

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ This will install the two main programs, dxdashboard (for the dashboard UI) and
3939

4040
If you are behind a proxy server, the nw package used by the Dashboard requires setting the http_proxy environment variable prior to running install. See this page for more information: https://www.npmjs.com/package/nw.
4141

42-
If you want to use the dashboard to handle Script Portlets you will need to install the following if not you do not need this installed to have the dahboard work for themes and designs.
4342
For the Script Portlet "Push" support, you will need to have the Script Portlet command line client support installed and configured, and you will need to have the "sp" command on your system path. See this documentation for more on installing the Script Portlet command line client: http://www-01.ibm.com/support/knowledgecenter/SSHRKX_8.5.0/script/script-portlet/cmd_line_push.dita
4443

4544
# Upgrade
@@ -86,8 +85,8 @@ When you first run the dashboard, you should go to the "Settings" tab to configu
8685
After setting a folder for Script Portlet applications in the settings tab, the
8786
toolkit provides a graphical interfaces for pushing script portlet applications.
8887
Pressing the "push" button will invoke the [`sp` command](http://www-01.ibm.com/support/knowledgecenter/SSHRKX_8.5.0/script/script-portlet/cmd_line_push_ovr.dita?lang=en) and push the
89-
application to the active server specified in the settings. If a `sp-config.json`
90-
file exists, it will be used when pushing the application. Pressing Tthe gear button
88+
application to the active server specified in the settings. If an `sp-config.json`
89+
file exists, it will be used when pushing the application. Pressing the gear button
9190
will open a dialog for editing the application's `sp_config.json` file.
9291

9392
In the same dialog box (at the bottom), there is an option to set a pre-push command
@@ -97,18 +96,26 @@ be run from the application's directory and will be run when pressing the push b
9796
or when the application's folder is being watched.
9897

9998
## Testing and Linting Script Portlet Applications
100-
Pressing the "SP Lint" button will run a linting utility for Script Portlet that
101-
will analyze the script portlet application and detect possible issues in the
102-
code where it is recommended to follow best practices.
103-
10499
Pressing the run button will runt the script portlet on a test server and open it
105-
in your browser. Although not complete, the test server locally simulates a Portal environment:
100+
in your browser. The test server is a small Express server that includes handling for WCM tags and Ajax Proxy requests:
106101
- Common WCM tags are replaced with mock data. A complete list of tags that replaced
107102
with mock data can be found [here](https://github.com/OpenNTF/WebDevToolkitForDx/blob/master/digexp-sp-server/tag-replacements.json)
108103
- AJAX requests that use Portal's Ajax proxy will be sent through a local proxy.
109104
The test server supports the ResourceURL tag and URLs that use "/wps/proxy/"
110105
- Other tags are removed and won't appear in the html.
111106

107+
Pressing the "SP Lint" button will run a linting utility for Script Portlet that
108+
will analyze the script portlet application and detect possible issues in the
109+
code where it is recommended to follow best practices.
110+
111+
## Working with themes in the Dashboard
112+
To work with theme files locally, first click "Get Themes" followed by "View Server Themes," then you will see a list of themes on the server. For any themes you want to access, enter the name to use for the local file folder and click "Create Theme Folders." Then to download the theme files, click the "Pull" button for the theme. Once you have pulled files for a theme, the "Pull" button will download only the files that have been changed on the server. To update the server with your local changes, click "Push Updates." You can also enable "Watch" to cause a push of updated files whenever change is made in your local folder.
113+
114+
## Working with WCM design files in the Dashboard
115+
To work with WCM design files locally, first click "Get Libraries" followed by "View Libraries." Then select the library or libraries you want to work with and click "Download Selected Libraries." To update the server with new or modified files, click "Push Updates" or "Push All." The "Pull" button will download all files. The "Watch" button will watch for changes to files in the local folder and push those changes automatically. Note that the "Push" commands won't delete any components on the server; for that you would need to use the WCM Authoring tools.
116+
117+
See below for details on the components that are supported with the WCM features.
118+
112119
# Using the"dxwcmdesigns" command line utility
113120
Note that all the functionality for push/pull of WCM design files is available from the Dashboard user interface. For the command line support, use:
114121
```

0 commit comments

Comments
 (0)