Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding the COMMUNICATION.md to the Standard Base Documentation pattern #589

Merged
merged 10 commits into from
Sep 14, 2023

Conversation

kschueths
Copy link
Contributor

Added COMMUNICATION.md and ADI instance

Added COMMUNICATION.md and ADI instance
@spier spier changed the title Update base-documentation.md Adding the COMMUNICATION.md to the Standard Base Documentation pattern Sep 12, 2023
@spier spier added 2-structured Patterns with existing instances (Please see our contribution handbook for details) 📖 Type - Content Work Working on contents is the main focus of this issue / PR labels Sep 12, 2023
Copy link
Member

@spier spier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kschueths thank you for taking the time to contribute this extension to the pattern!

I fixed a couple of formatting/wording changes myself.
Also made a change so that the COMMUNICATION.md will be rendered in the online book correctly.

Also left some inline comments. Merged one of them already that I was pretty certain of :)

If you could address the remaining comments, then I can get this merged in the very near future.

patterns/2-structured/project-setup/base-documentation.md Outdated Show resolved Hide resolved
patterns/2-structured/project-setup/base-documentation.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@kschueths kschueths left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for catching those

Copy link
Member

@spier spier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good now.
Will wait for checks to pass and then merge.

@spier spier added the 🐅 patterns-in-the-wild InnerSource patterns that were spotted in the wild. We can extract Known Instances and new patterns. label Sep 14, 2023
@spier spier merged commit c6670ce into InnerSourceCommons:main Sep 14, 2023
3 of 8 checks passed
@spier
Copy link
Member

spier commented Sep 14, 2023

Thanks again for sharing your COMMUNICATION.md approach with us @kschueths.
Your work is now published here: https://patterns.innersourcecommons.org/p/base-documentation#communication.md

rmarting pushed a commit to rmarting/InnerSourcePatterns that referenced this pull request Feb 29, 2024
InnerSourceCommons#589)

* Added COMMUNICATION.md and ADI instance to base-documentation.md.
* Adding COMMUNICATION template to the sidebar of the book (en only)0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2-structured Patterns with existing instances (Please see our contribution handbook for details) 📖 Type - Content Work Working on contents is the main focus of this issue / PR 🐅 patterns-in-the-wild InnerSource patterns that were spotted in the wild. We can extract Known Instances and new patterns.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Facilitate Communication with a COMMUNICATION.MD Document
2 participants