[LEDE-DEV] Lede/Openwrt documentation

[Paul Oranje]

M2C:

Wiki's are wonderful for documentation purposes as it allows anyone to attribute without much difficulty. But how to ensure that the documentation follows project code changes ?

Add to https://lede-project.org/submitting-patches the instruction that any change that would have consequences for documentation, be it for users (e.g. UCI), be it for developers:
- should mention in the commit message that the change affects user and/or developer docs (reviewers should check this)
- should be followed by an update of the wiki once the change has been merged (by submitter or someone else)

A more formal approach might be that any commit that changes API (developper documentation) or UCI (user documentation) must also contain a patch to that effect. A means to apply such a patch (and its format) to the wiki would be needed.

Last, assuming we maintain one set of user docs for all branches, the docs should, in case the branch matters, document those differences.
The developers documentation would presumably just need to document the master branch.

Paul


> Op 12 nov. 2017, om 02:32 heeft Alexander Couzens <lynxis at fe80.eu> het volgende geschreven:
> 
> Here is my IMHO:
> 
> wiki = OpenWrt and LEDE
> 
> The wiki is working for me. it's great to have the ToH. Also the device
> pages are great. However the wiki is not always completely correct and
> may be just wrong. It's a wiki, change it! A wiki is always changing.
> 
> But I still see the case, where I would like to have a documentation
> which is released for a specific version e.g. lede 17.01.
> I think this documentation should cover the base systems [1]. It should
> be describe things in a good and short way.
> And this documentation is reviewed before something changed. So it may
> be "guaranteed" [2] everything is right.
> 
> If it get's to depth into a topic, write it into the wiki.
> Documentation and Wiki would work this way hand in hand. Not erasing
> each other out.
> 
> best
> lynxis
> 
> ps. thanks to everybody who contributed to the wiki and documentation!
> 
> [1] what base system means in this context is to be defined.
> [2] there is no guarantee ;)
> 
> -- 
> Alexander Couzens
> 
> mail: lynxis at fe80.eu
> jabber: lynxis at fe80.eu
> mobile: +4915123277221
> gpg: 390D CF78 8BF9 AA50 4F8F  F1E2 C29E 9DA6 A0DF 8604
> _______________________________________________
> Lede-dev mailing list
> Lede-dev at lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/lede-dev