User story (meta) #1673

Be able to hide section in the output

Added by François ARMAND about 3 years ago. Updated over 2 years ago.

Status:Discussion Start date:2011-09-02
Priority:5 Due date:
Assignee:- % Done:

0%

Category:-
Target version:Rudder - Ideas (not version specific)
Needs translating:

Description

We are starting to think to some document items that will have to be cover in the long term. It would be great if we were able to say that some part are of the documentation are "draft" (or even just notes about topic) and that these part should be ignored for now.

Conditional include of external files may play the same role, even if that would be heavier to use (especially for small notes).

History

#1 Updated by Fabrice FLORE-THÉBAULT about 3 years ago

maybe use branch/merge features of git for that purpose ?

(i have never used it extensively, but have heard only success stories about that)

#2 Updated by Fabrice FLORE-THÉBAULT about 3 years ago

  • Status changed from New to Discussion
  • Target version set to Ideas (2.3 specific)

Maybe the best solution :

The content is a collection of .txt files, ordered into directories.

During the build of the documentation, a script is generating the actuel collection of .txt file to be included in the documentation, that is: which files, and in what order.

It will be really easy to tag some of these files so that the script will ignore them, or add them only under certain circumstances.

I see several ways to achieve this :

- symbolic links : files are created in some "fake" hierarchy, and then included into the actual hierarchy (same as sites-enabled for apache2 in Debian). Advantages : as many "actual hierachy" as needed. Drawbacks : maintenance issues expected.

- tags in name : add a "WIP" suffix to the files which are not ready. Advantages: keep it simple. Drawbacks : too much tags will kill the tags...

#3 Updated by François ARMAND almost 3 years ago

  • Target version changed from Ideas (2.3 specific) to Ideas (2.5 specific)

#4 Updated by Jonathan CLARKE over 2 years ago

  • Target version changed from Ideas (2.5 specific) to Ideas (not version specific)

Also available in: Atom PDF