-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 I did some cleanup of the user guide this morning. The repo page was getting pretty large, so I pulled out errata and distributions so that each have their own page.
A few reminders based on other changes I made: - - If you add a new section (something large enough that made you think to use the #section notation to identify it), don't forget to add a link to it from the main User Guide table of contents. - - When documenting commands that can process one or more things, be sure to indicate how to specify multiple items. For instance: "-f or --files File(s) to remove to this repository." doesn't indicate if multiple files should be comma-separated, use multiple instances of the -f flag, or some other means. This is also a case where an example helps. - - Please remember to proofread your docs, especially since these are user-facing. There were a number of typos that I corrected. Also remember that these are user docs and, while not the most formal guide in the world, still should follow some basic grammar. Two examples: * "Associate a package to a repository." - This is fine for a --help entry, but try to use full sentences in the user guide. * "from pulp server" - Should be "from the Pulp server". Also, remember to capitalize Pulp when referring to the project itself. - - Please fire off a quick e-mail to the team that the docs have been updated to request a proofreader. A second pair of eyes will often see all the little typos that the writer's eyes gloss over. Thanks :) - -- Jay Dobies RHCE# 805008743336126 Freenode: jdob http://pulpproject.org -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.14 (GNU/Linux) Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/ iQEcBAEBAgAGBQJNd59SAAoJEOMmcTqOSQHCNwQIAKe3c1srTdWWIa5ngP023ZZA C0paIUKhT4WVcCvKc6nbAE1MxpOFMU+5Z0ZwXhJwtjCdJpHG7R0NsrBxRBMPvIV2 Ww2ilpwafKJLtaDjYB/wY3AtOATkkxqRne2gk3c9TxxUTCoUPRhXbVLeV12qv79K 0nwW9/l+LYc8gyzUcEsXacrpc/eLFghy+/56/olerACCYsOgtraNeZ4Lta2HdeXb yz7Nj4DCIwlJIlkQ5SFZf19YvTYae+mAre1jzQPuRZdSx/pLqLS6xpj64heS7RmY syledaPr5bvb6XMtsvaZhPURgxsjCW06b3byh2H4AIKfFw98muubS8drN4tAYqo= =KdVY -----END PGP SIGNATURE----- _______________________________________________ Pulp-list mailing list [email protected] https://www.redhat.com/mailman/listinfo/pulp-list
