search

zowe / zlux

The top-level superproject for zLUX. zLUX includes the Zowe Desktop framework in addition to several built-in apps and an example server implementation.
Eclipse Public License 2.0
38 stars 42 forks source link

Documentation: How to ship default folders #927

Open 1000TurquoisePogs opened 1 year ago

1000TurquoisePogs commented 1 year ago

An app could bundle folders that it wants to be shown in the desktop by default. It would be done by placing json files in /config/folders

Each file is a folder, just a simple name & array of items. some items can be shortcuts, so you need a structure that declares whether each item is the name of an app or the name of a shortcut of an app.

Our app installer (zwe component install but also dynamic app loading!) needs to take these folder items and copy them into the config service location (workspace/app-server/ZLUX/...) similarly to what is done here https://github.com/zowe/zlux-server-framework/blob/v2.x/staging/utils/install-app.js#L207-L243

Then we need to document that users can do this.

Concern: Because folders could include other apps, its possible that 2 apps bring along the same folder name. What happens? Do you get 2, or do you get 1? Recommendation: if the contents are 100% duplicate, keep only 1.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs, but can be reopened if needed. Thank you for your contributions.