Zowe config init should place comments into config file

[gejohnston]

Is your feature or enhancement request related to a problem or limitation? Please describe

The purpose of some of the key properties of the configuration file may not be clear to consumers.

Describe your enhancement idea

Since the Zowe project asks customers to edit their zowe.config.json file, both the zowe config init and zowe config auto-init commands should place comments into the generated config file to instruct customers on what to do with the key properties of the config file.

Describe alternatives you've considered

Examples might be similar to the following:

// Profiles provide property values that let you connect to and properly utilize mainframe services.
"profiles": {
    
    // A zosmf profile is typically used to manage datasets and jobs.
    "zosmf": {
        ...
    },
    
    // A TSO profile establishes your account number and logon procedure for issuing TSO commands.
    "tso": {
        ...
    },

    // The ssh profile is used to make Secure Shell connections to USS.
    "ssh": {
        ...
    },

    /* A base profile is used to make a connection to APIML (host, port, and credentials).
     * When connecting to services through APIML, each of your other profiles should specify
     * a 'basePath' property to enable APIML to properly route your requests to the correct
     * mainframe service.
     *
     * If you are not using APIML, connection properties specified in the base profile
     * (like host, port, user, password, and rejectUnauthorized) will be used for every other
     * profile in your configuration, unless the property is explicitly specified in a given
     * service profile.
     */
    "base": {
        ...

        /* The values for property names specified in the 'secure' array associated with
         * any profile will be stored with the Zowe Secure Credential Manager instead of
         * being stored in this configuration file in plain text.
         */
        "secure": [
        ]
    }
},

/* You can specify multiple profiles of a given type (like zosmf, base, etc). You simply give
 * the new profile a different name. In the defaults section, you can specify which of your
 * numerous profiles of a given type will be used by default by your Zowe commands. By
 * specifying your desired profile name in the defaults section, you can type Zowe commands
 * for an extended period of time without having to override connection information on your
 * command line. When you switch the project that you are working on, when can change your
 * default profile in the defaults section until you are ready to switch again.
 */
"defaults": {
    ...
}

/* When you have NOT specified connection values for a service (like host, port, user, and password)
 * Zowe CLI will interactively prompt you for those values. After you have been prompted, Zowe CLI will
 * automatically store your answers if the 'autoStore' property is true. When autoStore is false or
 * not specified, every CLI command will continually prompt you for those values.
 */
"autoStore": true

Provide any additional context

[github-actions[bot]]

Thank you for raising this enhancement request. The community has 90 days to vote on it. If the enhancement receives at least 5 upvotes, it is added to our development backlog. If it receives fewer votes, the issue is closed.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

[github-actions[bot]]

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further.