Skip to content

Tendrl Documentation Scope Overview

Jump to bottom
Martin Bukatovič edited this page Jul 20, 2017 · 3 revisions

This is work in progress, I just want to sum up the current state before we can decide on next move. I will send an announcement on tednrl-devel when this page is ready for wider discussion.

This purpose of this wiki page is to clarify:

  • scope of each type of documentation we have
  • responsibilities among all tendrl contributors wrt the docs
  • which docs are no longer up to date and needs to be dropped/updated
  • which docs needs to be relocated

Current state

So to sum this up:

  • documentation repository contains mostly dev information
  • very few sections from documentation repository are still up to date
  • nobody seems to care about documentation repository recently
  • there is no html build of documentation repository
  • documentation repository is not referenced from tendrl.org page
  • wikipages looks more useful and up to date compared to documentation repository (from both devel and user point of view)

The questions we need to answer before going forward:

  • Where should dev details go? To documentation repo or wiki?
  • Should documentation repo contain dev details?
  • Where should end user (storage admin using tendrl) docs go?
  • Do we want to maintain html builds of user/hight level dev documentation in the similar way ceph or gluster does?
  • Do we want to resurrect currently dead documentation repository or do we want to use wiki only?
Clone this wiki locally