Skip to content

Commit

Permalink
Adding the COMMUNICATION.md to the Standard Base Documentation pattern (
Browse files Browse the repository at this point in the history
InnerSourceCommons#589)

* Added COMMUNICATION.md and ADI instance to base-documentation.md.
* Adding COMMUNICATION template to the sidebar of the book (en only)0
  • Loading branch information
kschueths authored and rmarting committed Feb 29, 2024
1 parent f5e3756 commit a7fa18a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions book/en/toc_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Instead edit toc_template.md
* Extras
* [README Template](../../patterns/2-structured/project-setup/templates/README-template.md)
* [CONTRIBUTING Template](../../patterns/2-structured/project-setup/templates/CONTRIBUTING-template.md)
* [COMMUNICATION Template](../../patterns/2-structured/project-setup/templates/COMMUNICATION-template.md)
* [CODE_OF_CONDUCT Template](../../patterns/2-structured/project-setup/templates/CODE_OF_CONDUCT-template.md)
* [RFC Template](../../patterns/2-structured/templates/rfc.md)

Expand Down
4 changes: 2 additions & 2 deletions patterns/2-structured/project-setup/base-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,7 @@ Pages like [how to write a readme that rocks](https://m.dotdev.co/how-to-write-a
the book [Producing Open Source](https://producingoss.com/en/producingoss.html)
all have valuable information on what kind of information to provide. While
Producing Open Source does not have a chapter on writing a good README per se,
the [Getting Started
chapter](https://producingoss.com/en/producingoss.html#starting-from-what-you-have)
the [Getting Started chapter](https://producingoss.com/en/producingoss.html#starting-from-what-you-have)
does provide a fairly extensive list of things that fellow host team members,
users and contributors will need. InnerSource projects likely will not cover all
of those aspects right from the start, the list itself is helpful for
Expand All @@ -128,6 +127,7 @@ started right away.
* Europace AG - See blog post [InnerSource: Adding base documentation](https://tech.europace.de/post/innersource-base-documentation/)
* Paypal Inc.
* Mercado Libre - create a documentation site that contains how to get started with InnerSource and also define the basic artifacts that a repository must have to be InnerSource (README, CONTRIBUTING, CODING_GUIDELINES, etc).
* Analog Devices Inc.

## Authors

Expand Down

0 comments on commit a7fa18a

Please sign in to comment.