docs-site icon indicating copy to clipboard operation
docs-site copied to clipboard

Doc Enhancement: Separate basic vs advanced tasks

Open BrandonJenkins14 opened this issue 4 years ago • 3 comments

Separate content by basic vs advanced tasks.

This could be done within each section, perhaps by moving those topics to the end of the section and prefixing the section heading like "(Advanced) Configure the xyz"

Or an entirely separate "Advanced Zowe concepts" topic could be created.

BrandonJenkins14 avatar Jun 08 '20 19:06 BrandonJenkins14

I'll start a list of topics I'm most familiar with. This might also help with the Issue #1257 if we decide to create groupings by components. Mostly CLI related, by maybe we could all add to this list, then we can narrow it down later?

Basic:

  • Zowe Overview
  • Zowe FAQs
  • Zowe CLI Quick Start
  • Installing CLI
  • Updating CLI
  • Zowe getting started tutorial
  • Displaying Zowe CLI help
  • Issuing commands (CLI)
  • Using profiles (CLI)
  • Testing connection to z/OSMF (CLI)
  • Zowe CLI Plug-ins

Advanced:

  • Zowe architecture
  • Related resources
  • Integrating w/ API ML (CLI)
  • Working with certificates (CLI)
  • Using environment variables (CLI)
  • Using the prompt feature (CLI)
  • Writing scripts (CLI)
  • All "advanced Zowe configuration" topics
  • All "troubleshooting" topics
  • All "developing for x" topics

BrandonJenkins14 avatar Jun 10 '20 19:06 BrandonJenkins14

A flash of inspiration - we could organize a layout that has 2 main sections - Basic vs Advanced.

Within those sections, have subsections by role like "CLI User", "Extension developer", "System programmer/security admin"

There, you've killed two birds with one stone! What do you think

BrandonJenkins14 avatar Jun 10 '20 19:06 BrandonJenkins14

@BrandonJenkins14 Great start! We might need a place where all community members can collaborate to define the topics and roles. Also found some interesting docs of similar concept:

nannanli avatar Jun 11 '20 09:06 nannanli