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

Add Community Report to Handbook #230

Merged
merged 9 commits into from
Aug 26, 2020
Merged

Conversation

GeorgLink
Copy link
Member

This PR is for adding a handbook page for describing the process CHAOSS follows for delivering the Community Report.

Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
@GeorgLink GeorgLink marked this pull request as ready for review August 12, 2020 23:55

When the CHAOSS community receives a request for a report, the following steps will be taken:

* TBD by TBD
Copy link
Collaborator

Choose a reason for hiding this comment

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

?? :)

Copy link
Member

Choose a reason for hiding this comment

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

I might suggest this here:

  • Coordinator notifies points of contact from Augur and GrimoireLab a request has been submitted.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Does this have to be manual? The coordinator and point of contact from Augur and GrimoireLab should be notified through an autogenerated email once the form is submitted. A coordinator can followup for getting desired visualizations for generation of pdf.

Copy link
Member

Choose a reason for hiding this comment

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

@vinodkahuja I think they do get those emails; this was more of a failsafe so nothing falls through the cracks. Maybe we don't need that though. 🤔 It definitely would streamline the process a little!

Copy link
Member Author

Choose a reason for hiding this comment

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

I left the "TBD by TBD" here so that we are prompted to think of steps not yet in this list, like @ElizabethN 's suggestion.

* Insert visualizations in template by TBD
* Send Community Report to requester by TBD
* If requester gave permission, add Community Report to our library on CHAOSS.community by TBD

Copy link
Collaborator

Choose a reason for hiding this comment

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

do we have to identify names? I'm guessing this is the TBD.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@GeorgLink added some comments.

Copy link
Member Author

Choose a reason for hiding this comment

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

"by TBD" is to specify which role execute an action item. We can specify somewhere which persons are fulfilling each role.

@@ -0,0 +1,33 @@
# Community Report

The CHAOSS Community Report is a free service that the CHAOSS community provides to open source communities.
Copy link
Member

Choose a reason for hiding this comment

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

@germonprez because this is a joint effort with the LF do we need to explicitly say that here? Or is it ok to just mention CHAOSS?

Copy link
Member

@ElizabethN ElizabethN left a comment

Choose a reason for hiding this comment

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

Added some comments for you to ponder 😄

Copy link
Member Author

@GeorgLink GeorgLink left a comment

Choose a reason for hiding this comment

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

I responded to everyone's comments.

May I ask using the "suggest" changes feature for typos and other minor changes to the document. (I learned this from @SMotaal and find it hugely helpful for other reviewers to know exactly what changes you suggest.)

Screen Shot 2020-08-21 at 2 34 12 PM

community-handbook/community-report.md Outdated Show resolved Hide resolved
community-handbook/community-report.md Outdated Show resolved Hide resolved
community-handbook/community-report.md Outdated Show resolved Hide resolved
community-handbook/community-report.md Outdated Show resolved Hide resolved
community-handbook/community-report.md Outdated Show resolved Hide resolved
community-handbook/community-report.md Outdated Show resolved Hide resolved
community-handbook/community-report.md Outdated Show resolved Hide resolved
community-handbook/community-report.md Outdated Show resolved Hide resolved
* Insert visualizations in template by TBD
* Send Community Report to requester by TBD
* If requester gave permission, add Community Report to our library on CHAOSS.community by TBD

Copy link
Member Author

Choose a reason for hiding this comment

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

"by TBD" is to specify which role execute an action item. We can specify somewhere which persons are fulfilling each role.

Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
Copy link
Member Author

@GeorgLink GeorgLink left a comment

Choose a reason for hiding this comment

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

These comments suggest writing the steps in the formula:

  • Role does something


When the CHAOSS community receives a request for a report, the following steps will be taken:

* TBD by TBD
Copy link
Member Author

Choose a reason for hiding this comment

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

I left the "TBD by TBD" here so that we are prompted to think of steps not yet in this list, like @ElizabethN 's suggestion.

When the CHAOSS community receives a request for a report, the following steps will be taken:

* TBD by TBD
* Get visualizations from Augur by TBD
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
* Get visualizations from Augur by TBD
* Coordinator notifies Software Operators of Augur and GrimoireLab that a request has been submitted by Coordinator
* Software Operators get visualizations from Augur and GrimoireLab and upload them to a shared Google Drive

Comment on lines 29 to 30
* Get visualizations from Cauldron/GrimoireLab by TBD
* Insert visualizations in the template by Coordinator
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
* Get visualizations from Cauldron/GrimoireLab by TBD
* Insert visualizations in the template by Coordinator
* Coordinator gets visualizations from the shared Google Drive and inserts them in the template

Comment on lines 31 to 32
* Send Community Report to the requester by Coordinator
* If requester gave permission, add Community Report to our library on CHAOSS.community by Coordinator
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
* Send Community Report to the requester by Coordinator
* If requester gave permission, add Community Report to our library on CHAOSS.community by Coordinator
* Coordinator sends Community Report to the Requester
* If requester gave permission, Coordinator adds Community Report to our library on CHAOSS.community

@ElizabethN
Copy link
Member

I responded to everyone's comments.

May I ask using the "suggest" changes feature for typos and other minor changes to the document. (I learned this from @SMotaal and find it hugely helpful for other reviewers to know exactly what changes you suggest.)

Screen Shot 2020-08-21 at 2 34 12 PM

🤯 Today I learned!! Great to know this is a feature, I had no idea it existed. Thank you!

Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
@GeorgLink GeorgLink merged commit a4a61bf into master Aug 26, 2020
@ElizabethN ElizabethN deleted the add-community-report-handbook branch February 3, 2023 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants