-
Notifications
You must be signed in to change notification settings - Fork 133
Zowe.org design
nannanli edited this page May 21, 2020
·
2 revisions
- The search function is very useful but a lot of customers are not aware that they could search the docs. The search button is not so outstanding or obvious. We could perhaps so something to improve this.
- Can we move the search box to zowe.org, for example. a box perhaps labeled Search docs.
- Can troubleshooting information be clearer in the zowe.org with a (getting help if your desktop doesn't start, getting help if your install failed, ...) like an FAQ
- Also, on zowe.org, when people click Docs, they are not directed to the doc site immediately. Instead, they are directed to the section below and have to click Read the docs again to go to the doc site. This could be improved. --Done
- The Docs section can also add more useful links like Installing z/OS components.
- The video should be updated.
- People cannot easily discover some useful guidelines, such as the video guideline (how to contribute a video).
- When users come to the site for the first time, they don't know where and how to get started. Suggest we add a role-based/personalized quick start section that directs users to related resources.
- We have the What's Zowe section, but don't explain why/the benefits of adopting Zowe.
- There are so many buttons on the Download section. I don't always understand the relationship.
- Suggest we add Getting started and Trial buttons to the header of the page, just like other websites.
- PR https://github.com/zowe/zowe.github.io/pull/85: Add Medium blog site
- PR https://github.com/zowe/zowe.github.io/pull/50: Add Who's using Zowe
- Doc readiness checklist
- Doc planning
- Doc maintainers
- What is the Pull Request process and how to submit a PR?
- Build and Archive Legacy Documentation
- How to check broken links
- How to build PDF
- How to add a new file to the site
- How to build the site
- How to prepare appendix for a new release
- How to embed videos in Zowe docs
- How to write what's new/release notes
- How to report documentation progress and status?
- How to author in Markdown?
- How to author content or a new release? What process to follow?