openmainframeproject-internship / Zowe-Improve-Doc-site-generator-and-UI

Revamped Zowe Docs site.

Home Page:https://docs.zowe.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Zowe Doc site generator and UI

zowe-template-omp-project

Project Description

The Zowe doc site is built using Vuepress. With the content for the site growing in size and complexity, users need better user experience. Complete project description/requirements of the project could be found here.

Why a new site generator is being considered

  • Vuepress now has a limitation for the nav depth. It does not support nested sidebar thus some sections cannot be further organized.
  • We want to improve the current Vuepress site layout to be a standard three column layout supporting better navigation experience.
  • Many other functions are wanted but not available on the site now. For example, social functions like Share, Feedback, and more importantly the ability to generate a PDF file automatically.
  • Considering the growth of the community, multilingual support will be wanted for Zowe docs in the near future.
Folder Description
Documentation Detailed description and design/architectural requirements of the project
Notes and Research Relavent information useful to understand the tools and techniques used in the project
Status Reports Project management documentation - weekly reports, milestones, etc.
src Source code of the new prototyped website built using ReactJS based site generator

Project Team

About

Revamped Zowe Docs site.

https://docs.zowe.org


Languages

Language:JavaScript 74.6%Language:CSS 17.3%Language:Groovy 7.2%Language:Shell 0.8%Language:HTML 0.1%