Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 3.97 KB

Zowe Docs Objectives.md

File metadata and controls

74 lines (51 loc) · 3.97 KB
Raw

Zowe Docs Squad - 20PI3 Objectives (June 2020 to September 2020)

Zowe doc site

  1. Zowe users can learn about and use new Zowe features successfully by reading the documentation.

    Deliverable: Documentation for new features and enhancements of each release are published on the doc site.

    • Zowe API Mediation Layer
      • Document new authentication method for Zowe using client certs 
      • Document removal of z/OSMF pre-req to run the Mediation Layer 
      • Document ability to run Zowe in High Availability mode
    • Zowe CLI
      • Deliver SSO capability doc with 1.13.0
      • Document new global CLI profiles 
      • Document Zowe Node and Python SDKs and sample use cases (overview, user guide, extending, buttons to zowe.org)  #1286 and #1287
    • Zowe Web UI/Application Framework 
      • Refactor installation doc 
      • Clarify terms
    • Zowe Explorer
      • Zowe Explorer documentation update to support the hills
    • Zowe installation
      • Install doc for the Upgrade scenario #1263
      • Separate installation content (Install VS Use) #1256
      • High impact install doc enhancements and fixes (see list of GitHub issues)

    Dependency: All squads

    Risk: None

  2. Zowe users can get and browse a list of interested topics within a few clicks by selecting an area of interest, role, and skill level. #1257

    Deliverable:

    • Buttons on Zowe doc site that users can select.
    • Topics are tagged and organized by applicable component, user role, and skill level.
    • Present a list of topics based on user's choice.

    Dependency:

    • On-boarding squad (collaborate on identifying personas, resources)
    • Systems squad or web UI squad (potential build and technical support)

  3. Zowe contributors can begin contributing to documentation, code, and test by reading the contribution guide on the doc site. #1276 and #1179

    Deliverable:

    • Publish enriched contribution documentation and guidelines on the doc site that contain clear process, links to related tools education, examples, and demos where necessary.
    • Separate maintainer doc with contributor doc. 

    Dependency and risk: None

  4. Zowe users can learn about all the new features, enhancements, and bug fixes and understand the business value of notable changes by reading the release notes that contain links to related GitHub issues and Pull Requests without having to read separate CHANGELOGs scattered in multiple repos. #846

    Deliverable:

    • Consistent CHANGELOGs containing issue numbers or PR numbers are set up in dev repos.
    • Automatic build set up to copy CHANGELOG content of the release to release notes for publish. 

    Dependency: All squads (unify CHANGELOG format and style)

  5. Zowe users can install, configure, and use Zowe by watching a series of videos or view diagrams. #1239 and #38

    Deliverable:

    • More visual content for different components.
    • A video course or video gallery where users can find a list of available education videos. 

    Dependency and risk: None

Zowe.org website

  1. Zowe users can navigate the Zowe.org website to find links to useful information and download Zowe builds successfully without having to ask in other channels. #93

    Deliverable:

    Website content and design improvements that are published to Zowe.org.

    Dependency: Onboarding squad, OMP