[389-devel] Re: Please review: Ticket 49793 - Updated descriptions in dscreate example INF file

[Marc Muehlfeld]

Attached a new patch with updated header that follows the project's 
conventions.

Ticket: https://pagure.io/389-ds-base/issue/49793

Regards,
Marc


On 18.06.2018 12:51, Marc Muehlfeld wrote:
>  Hi,
>  
>  with regard to documentation, I made some changes to the "dscreate 
>  example" output:
>  
>  1) I slightly changed the format of the comments to:
>      parameter_name (type) [REQUIRED|optional]
>      Description: ...
>      Default value: ...
>  
>  2) I rewrote the parameter descriptions. They should be now
>      more clear.
>  
>  3) By default, all parameters are now commented out. I added a note
>      to the intro that the [REQUIRED]-flagged parameters must be
>      set.
>  
>  With these changes, writing the documentation simplifies:
>  * I can tell in the docs to uncomment the [REQUIRED]
>     parameters and set them to have a minimal INF file.
>     Previously, it was harder to to identify the required
>     parameters (the ones which were not commented out).
>  * Instead of describing the parameters in the RH docs, I can
>     now refer to the "dscreate example" output, because the
>     descriptions should be more detailed.
>  
>  Please review the attached patch and push. Thanks.
>  
>  
>  Regards,
>  Marc
>  
>  
>  
>  
>  
>  _______________________________________________
>  389-devel mailing list -- 389-devel(a)lists.fedoraproject.org
>  To unsubscribe send an email to 389-devel-leave(a)lists.fedoraproject.org
>  Fedora Code of Conduct: https://getfedora.org/code-of-conduct.html
>  List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
>  List Archives:
> https://lists.fedoraproject.org/archives/list/[e-mail]...
>   



-- 
Marc Muehlfeld
Senior Technical Writer, Customer Content Services

Red Hat GmbH
Technopark II,
Werner-von-Siemens-Ring 14
85630 Grasbrunn
Germany

Email: mmuehlfeld(a)redhat.com
_______________________________________________________________________________
Red Hat GmbH, http://www.de.redhat.com/, Registered seat: Grasbrunn,
Commercial register: Amtsgericht Muenchen, HRB 153243,
Managing Directors: Charles Cachera, Michael Cunningham,
Michael O'Neill, Eric Shander