Skip to content

User feedback and content update

nannanli edited this page Jul 2, 2020 · 11 revisions

User feedback is important to us. As a user, your feedback is not only heard. We value them and are making progress to address them to provide enhanced content experience. This section lists the user feedback on Zowe documentation that requires action and provides an update if any to each feedback.

Feedback channels

This section documents the anonymous comments that are received in the following channels and which require content updates.

  • NPS (Net Promoter Score)

    When a user stays on the Zowe doc site for sometime, an NPS board pops up asking the user how likely they are going to recommend Zowe Docs to other colleagues or friends. The user can also comment to provide more details.

  • Zowe Documentation Survey

    The Zowe documentation survey is located on the navbar of the Zowe doc site which directs users to a Google Form where they will answer several questions.

User feedback in other channels including Slack are directly converted into GitHub issues for tracking.

Feedback and progress

Feedback from NPS

In progress

  • La documentación es muy difícil de entender, le hace falta tener una guía de instlación y puesta en funcionamiento con cada uno de los requerimientos de software y el paso a paso para la instalación y puesta en marcha del entorno de desarrollo. La verdad ya tengo varios días y no he podido tener instalado mi ambiente de desarrollo. Espero que desarrollen una guía paso a paso y unos videos dónde se explique desde el principio hasta dejar el ambiente de desarrollo listo. (Google translate: The documentation is very difficult to understand, you need to have an installation and commissioning guide with each of the software requirements and the step by step for the installation and commissioning of the development environment. The truth is that I already have several days and I could not have installed my development environment. I hope they develop a step-by-step guide and some videos where it is explained from the beginning until the development environment is ready.)

    Status: Backlog. Aligns with some focus areas of the Zowe docs. Will provide more updates here.

  • It would nice to have an online repo for all error messages though, like other products. I had to dig to figure out what was wrong (couldn't login to Zowe b/c of the cross memery server)

    [Update] This is a good suggestion. Thanks! This is one thing that the community has been doing. In v1.8.0, the APIML error messages will be published first. See the work in progress: https://github.com/zowe/docs-site/blob/master/docs/troubleshoot/troubleshoot-apiml-error-codes.md.

  • Your documentation does not list all possible return codes for zlux-app-server log. I am getting RC=12 on ZWESIS server ZIS status for 1.7.1. Consequently, I had to backout back to 1.4.0.

    [Update] Under investigation

  • документация скудная. нет подробного описания переконфигурации компонентов` (Google translate: The documentation is scant. No detailed description of component reconfiguration.)

    [Update] Issue https://github.com/zowe/docs-site/issues/366 is opened as part of the solution.

  • It would be highly helpful if someone can create an educational video on installing Zowe. Personal would like video for Installing Zowe CLI.

    [Update] Issue #38 is tracking the videos.

  • Hard to figure out where to start... the doc talks about services/APIs - where are they documented??????

    [Update] Issue #537 and #485 are opened and under investigation.

  • You are offering no hands on classes on z/OSMF. 6/6/19

    [Update] Added a video about setting up z/OSMF on the doc site. Consider other formats and resources that would help improve the experience.

  • Little more information need to understand about localhost mentioned in the document ,is it referring to mainframes or LUW confusing.

    [Update] Under investigation.

Resolved

  • Can someone please update the docs npm config set @brightside:registry https://api.bintray.com/npm/ca/brightside this should be a zowe repo (01/09/2020)

    [Update] At this time, that is actually the correct syntax for the 1.x releases. The community is aware of this old Brightside artifact, and there is a plan to transition away from it in the next major release. To change it now would be considered a "Breaking change". In our Active Development version, the command is already documented as npm config set @zowe:registry. (01/14/2020)

  • We are presently in the development phase with zowe, we think it has potential to become something great in future. Will there be an SMPE version of zowe coming up later? Thanks for the support. 8/9/19

    [Update] A pre-release of the Zowe SMP/E install was rolled out on Sep 2, 2019. You can obtain the build from Zowe.org. This is an alpha release based on Zowe 1.4.0, and should not be used in production. After you obtain the build, you can follow the instructions on the Zowe doc site to install it. Last updated: 9/3/19

  • What is the use/point of pages that have a 1 line description? 5/1/19

    [Update] Fixed. Cleaned up the 1-line pages and improved the doc flow. Issue #536 tracks the details. Last updated: 5/17/19

  • There is very little information on how the apps in the ZOWE desktop work. 3/15/19

    [Update] Enriched information about the Editor and Workflow app. Created a getting started tutorial to walk you through some apps that are installed by default. See the doc site for more details in the Using the Zowe Desktop section. Last updated: 8/20/19

  • Under Zowe Application Framework there is a link/button for more information but it doesn't work. not sure if it's an IE thing. 6/12/19

    [Update] Fixed.

  • Estoy intentando solucionar una incidencia y no veo documentado el error. Estoy intentando instalar ZOWE en zD&T. (Google translated: I am trying to solve an issue and I don't see the error documented. I am trying to install ZOWE on zD & T.) 6/11/19

    el error ===>
    {"messages":[{"messageType":"ERROR","messageNumber":"MFS0103","messageContent":"The endpoint you were looking   for '/ui/v1/explorer-mvs/' could not be located","messageKey":"com.ca.mfaas.common.endPointNotFound"}]}
    

    [Update] Enriched the troubleshooting information. Also added information to reach out to the community and open GitHub issues to seek support and solution to the problem. While we're continuously documenting the errors that we know, we encourage everyone who encountered and solved errors to open a PR to update the doc site after you find a solution to benefit the whole community.

Feedback from doc survey

In progress

N/A

Resolved

  • Lack of information about problems faced during install. Have a list of errors/problems people have had when trying to install and provide possible solutions.

    [Update] Enriched the troubleshooting information to provide detailed troubleshooting process and a list of known issues and solutions. See Troubleshooting.

  • Setup zlux on linux laptop with zss on tutorial system. Zowe site points to IBM developer tutorial but this is not in sync with actual zowe github repository. Sync doc with github repository (see slack channel zowe-tutorial-system)

    [Update] The tutorial has been updated. Also there is a Slack channel for this tutorial now to facilitate communication.