Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Users and User Stories

We would like to support different users with clear paths to follow in finding what they need in the CDAP documentation.

...

It's possible that certain users may fall into more than one category. For example, a User may want to install CDAP themselves, in a Standalone setting, as part of a review process, in order to evaluate its appropriateness for their situation before passing it to an Administrator/Operator for adding it to a cluster.

Different Paths

We can identify paths either by user or by theme, where the themes would be the interests listed above.

...

Another example is the documentation for the Django Project. It shows "The basics" and "Advanced" links for each thematic area.

Introduction Pages

Each manual—and the Documentation itself—has an "Introduction" page at the start.

Currently

...

These pages are a list of links with descriptions and important terms or phrases marked in bold:

Proposal

...

Have a tabbed panel that shows for different user streams appropriate content (note: the content would not be a literal; that is a limitation of the current custom Sphinx extension used to illustrate this):

...