1.7 KiB
book6
A collaborative IPv6 book.
This is a first draft of how to contribute.
Contributors will be self-declared practitioners of IPv6. There is no other entry ticket except a valid GitHub account.
Contributions (in markdown format) will fit into an agreed table of contents. They will be factual and will teach technical readers about a particular aspect of IPv6. As far as possible, references will be to RFCs and other freely available documents.
Where there are alternatives and choices for people deploying or using IPv6, the choices will be presented objectively, if possible with factual pros and cons. Justified recommendations may be be made (e.g., "X is generally more secure than Y") but strong personal opinions (e.g., "NAT66 is never the right answer") should be avoided.
Contributors may edit their own and other contributions. However, significant changes should first be discussed using the issue tracker. That isn't necessary for spelling mistakes, grammar problems, or small nits. GitHub PRs will be used when necessary (i.e., where the changes need review).
Preferably, a contribution will be a complete section. There will be a naming convention for files, based on the table of contents, so that some clever person can write a script to generate the whole book from the repo.
Note that contributions MUST be original writing unless the contributor has the legal right to submit the material under the agreed license (see LICENSE.md).
TBD: We should probably appoint two or three people as top-level editors who can approve PRs.
TBD: Diagrams will be XXXX (or
ASCII art
for simple stuff).
The language is English, preferably US spelling.
TBD: What about translation into other languages?