Vscode-extension-for-zowe: Ensure docs for Zowe Explorer are up-to-date

Created on 14 Oct 2020  路  6Comments  路  Source: zowe/vscode-extension-for-zowe

We should make sure that the Explorer section of docs.zowe.org has up-to-date information about all the new functions we've been adding :)

@IgorCATech and I decided to make a list of all the functions, and then we can check what's up with the docs. So yeah here's the issue for that :)

Feel free to add whatever.

Research Needed Technical Debt UX backlog docs in progress

All 6 comments

Cool beans @katelynienaber Ok, so here's the list so far:

  • Allocate Like
  • Base Profiles
  • Allocate multiple data sets from JSON file

@zdmullen Surely, you know more ;) Feel free to add them

On another but related note, the videos are outdated, so it would be nice to work on them at some point.

Topics that could maybe have some section in docs

Haven't checked if docs have these yet, just brainstorming, some were mentioned by @IgorCATech:

  • A note about each of the leetle toolbar icons and what it does
    (if this PR is merged then this is kinda irrelevant, since the leetle icons will be gone)
  • settings.json file (what it should have in it, common issues)
  • A list of all the currently-supported MF functionality (see section below, _Maybe these functions exist..._)
  • Base profiles
  • Profile validation enable/disable
  • Filter/search (brief note so people know they can use *)
  • linkProfileDialog function
  • Session creation (Maybe some hints for beginners, what to put in the boxes), hiding/deletion (What's the difference?)

Maybe these functions exist in IBM's MF docs and don't need docs in our docs:

But we could list/mention them as functionality that Explorer supports
We could link to the IBM docs in our docs XD
jobActions.modifyCommand
dsActions.allocateLike
jobActions.downloadSpool
jobActions.downloadJcl
dsActions.hMigrateDataSet
dsActions.hRecallDataSet
jobActions.getSpoolContent
MvsCommandHandler.getInstance().issueMvsCommand
dsActions.submitJcl
dsActions.submitMember
dsActions.showDSAttributes

Don't need docs:

Probably clear from how VSCode functions:
dsActions.refreshPS
dsActions.openPS
dsActions.copyDataSet
dsActions.pasteDataSet
node.openUSS
ussFileProvider.rename

Probably clear from context menu text:
dsActions.createMember
datasetProvider.rename
dsActions.deleteDataset
ussActions.refreshAllUSS
node.refreshUSS
ussActions.refreshUSSInTree
node.deleteUSSNode
ussFileProvider.deleteSession
ussActions.copyPath
ussFileProvider.editSession
ussFileProvider.removeFavorite
jobsProvider.delete
jobActions.stopCommand
jobActions.refreshAllJobs
jobActions.refreshJobsServer
ussFileProvider.addFavorite
jobActions.setOwner
jobActions.setPrefix
jobsProvider.filterPrompt
ussActions.createUSSNode
ussActions.uploadDialog
dsActions.uploadDialog
dsActions.createFile

These functions are only used internally:
zowe.setJobSpool - To focus the tree view on a single job
ussActions.changeFileType - To change file type (ex. to try re-downloading a file as binary)

We tend not to document enhancements of UI. Good UI/UX needs no doc :P

So thanks for creating this. One thing I want to stress however, is that we do not get in the habit of creating these kinds of issues, but instead check up on the development as it's happening and make sure we maintain the doc continuously. This also depends on contributors actively marking their PRs as "Updates to documentation" in the checklist.

Closing this in favor of the doc epic

Was this page helpful?
0 / 5 - 0 ratings