mirror of
https://github.com/becarpenter/book6.git
synced 2024-05-07 02:54:53 +00:00
Incitements to contribute
This commit is contained in:
@ -4,7 +4,7 @@ If you find an error or a gap in this book, or a recommendation that you
|
||||
disagree with on the basis of practical experience, you are most welcome
|
||||
either to raise an issue, or even better to draft updated or new text.
|
||||
We are maintaining this book using GitHub - see the
|
||||
[book6 repository](https://github.com/becarpenter/book6) for details.
|
||||
[book6 repository](https://github.com/becarpenter/book6).
|
||||
|
||||
You can raise issues through the book's
|
||||
[issue tracker](https://github.com/becarpenter/book6/issues). General
|
||||
@ -12,7 +12,8 @@ discussions also take place
|
||||
[here on GitHub](https://github.com/becarpenter/book6/discussions).
|
||||
|
||||
To become an active contributor
|
||||
[check the conditions](https://github.com/becarpenter/book6/blob/main/CONTRIBUTING.md).
|
||||
[check the conditions](https://github.com/becarpenter/book6/blob/main/CONTRIBUTING.md)
|
||||
[and instructions](https://github.com/becarpenter/book6/blob/main/99.%20Chapter%20Template/99.%20Chapter%20Template.md). Then submit GitHub PRs.
|
||||
Your contributions will be reviewed by an editorial team.
|
||||
|
||||
### [<ins>Previous</ins>](How%20to%20keep%20up%20to%20date.md) [<ins>Next</ins>](Acknowledgments.md) [<ins>Chapter Contents</ins>](1.%20Introduction%20and%20Foreword.md)
|
||||
|
@ -1,5 +1,7 @@
|
||||
# 9. Troubleshooting
|
||||
|
||||
If you know what should be written here, please write it! [How to contribute.](https://github.com/becarpenter/book6/blob/main/1.%20Introduction%20and%20Foreword/How%20to%20contribute.md#how-to-contribute)
|
||||
|
||||
## [Advanced Troubleshooting](Advanced%20Troubleshooting.md)
|
||||
|
||||
## [Tools](Tools.md)
|
||||
|
@ -1,6 +1,6 @@
|
||||
## Last Section
|
||||
## Advanced Troubleshooting
|
||||
|
||||
Section text goes here
|
||||
If you know what should be written here, please write it! [How to contribute.](https://github.com/becarpenter/book6/blob/main/1.%20Introduction%20and%20Foreword/How%20to%20contribute.md#how-to-contribute)
|
||||
|
||||
<!-- Link lines generated automatically; do not delete -->
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
## First Section
|
||||
## Tools
|
||||
|
||||
Section text goes here
|
||||
If you know what should be written here, please write it! [How to contribute.](https://github.com/becarpenter/book6/blob/main/1.%20Introduction%20and%20Foreword/How%20to%20contribute.md#how-to-contribute)
|
||||
|
||||
<!-- Link lines generated automatically; do not delete -->
|
||||
|
||||
|
@ -8,11 +8,13 @@ Contributions (in GitHub markdown format) will fit into an agreed [table of cont
|
||||
|
||||
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 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). The goal is to achieve IETF-style rough consensus on the content. A typical tie-breaker argument is "I have deployed this and it works well."
|
||||
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 additions or changes need review). The goal is to achieve IETF-style rough consensus on the content. A typical tie-breaker argument is "I have deployed this and it works well."
|
||||
|
||||
Normal, a contribution will be a complete section. There is a naming convention for files, based on the table of contents, so that we can write a script to generate the whole book from the repo. See the [basic chapter template](99.%20Chapter%20Template/99.%20Chapter%20Template.md) and follow it carefully.
|
||||
That chapter also contains instructions for the use of GitHub markdown. Please create a separate file for each section within the folder for its chapter. See the chapter template itself for detailed instructions. If you don't follow these instructions, things will get messed up and will need to be sorted out manually.
|
||||
|
||||
If you prefer to submit a PR containing plain text, somebody will eventually add markdown, but there may be a delay. Please don't submit other formats.
|
||||
|
||||
Note that contributions **MUST** be original writing unless the contributor has the legal right to submit existing material under the agreed license (see [LICENSE.md](LICENSE.md)).
|
||||
|
||||
If we use direct quotations from RFCs they **MUST** be small extracts that can be considered "fair use" as mentioned in the relevant [IETF Trust FAQ](https://trustee.ietf.org/about/faq/#reproducing-rfcs) under "Am I allowed to reproduce extracts from RFCs?" However, *modified* extracts from RFCs are not allowed.
|
||||
|
Reference in New Issue
Block a user