Hello team,

as part of https://issues.apache.org/jira/browse/OAK-3894 I was planning
a restructure of our documentation site. In particular I was thinking
about an easier way to add/update documentation about oak specific features.

Currently we have a section in the left-hand menu: Features and plugins.
This mean that if we add a feature over there we have to update the
whole doc site as the menu is eventually static in all pages.

My suggestion is to move such section into a specific page features.hml
under the section: Using Oak. Then to move content around under a
subdirectory `features`. We'll eventually have something like:

/oak/docs/features.html (lists all the features)
/oak/docs/features/nodestore/overview.html
/oak/docs/features/plugins/blobstore.html
/oak/docs/features/nodestore/documentmk.html
/oak/docs/features/nodestore/segment/overview.html
/oak/docs/features/query/query.html
/oak/docs/features/security/overview.html
/oak/docs/features/clustering.html
/oak/docs/features/nodestore/persistent-cache.html

This will allow us later on to update and add features by simply
committing the features.html plus all the changed pages.

Thoughts?

Davide

Reply via email to