[Gluster-devel] Feature Classification & Quality Expectation.

[John Mulligan]

On Friday, July 20, 2018 3:16:47 AM EDT Amar Tumballi wrote:
> We sent an email few days back for proposal to deprecate some features in
> glusterfs (
> https://lists.gluster.org/pipermail/gluster-devel/2018-July/054997.html).
> 
> Shyam recently sent the document as a patch upstream Gluster @
> https://review.gluster.org/20538/. (Same is copied below in email here).
> Please provide your valuable feedback on the same, so we can make it a
> general practice.
> 
> This is done for making things more clear about proper expectation from
> each of the component/feature, we want to have more classification of each
> feature, control them using the code itself, and make sure we keep the list
> up-to-date with each release, so our users have proper expectations set.
> 
> <content-from-patch>
> 
> The purpose of the document is to define a classification for various
> xlators and expectations around what each classification means from a
> perspective of health and maintenance of the xlator.
> 
> The need to do this is to ensure certain classifications are kept in good
> health, and helps the community and contributors focus efforts on around
> the same.
> <https://hackmd.io/q_aEokbxSBSN-LdoaJ6Z6A#Classifications>Classifications
> 
>    1. Experimental (E)
>    2. TechPreview (TP)
>    3. Maintained/Supported (M)
>    4. Sunset (S)
>    5. Deprecated (D)
> 
>

When I scanned through the list I thought that you may want to consider an 
additional category. This category would be an xlator that exists in the code 
for documentation/demonstration purposes. For example the rot13 translator was 
used in the docs to help demonstrate how to write a translator. The value of 
keeping a translator in the source tree is that it continues to be updated and 
compiled along with the rest of the code. If it exists purely as embedded text 
in a document then it can go out-of-sync with the rest of the code.