-
-
Notifications
You must be signed in to change notification settings - Fork 173
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
Conversation
Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
Signed-off-by: Georg J.P. Link <linkgeorg@gmail.com>
|
||
When the CHAOSS community receives a request for a report, the following steps will be taken: | ||
|
||
* TBD by TBD |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
?? :)
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
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 | ||
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GeorgLink added some comments.
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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?
There was a problem hiding this 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 😄
There was a problem hiding this 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.)
* 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 | ||
|
There was a problem hiding this comment.
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>
There was a problem hiding this 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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* 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 |
* Get visualizations from Cauldron/GrimoireLab by TBD | ||
* Insert visualizations in the template by Coordinator |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* 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 |
* Send Community Report to the requester by Coordinator | ||
* If requester gave permission, add Community Report to our library on CHAOSS.community by Coordinator |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* 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 |
🤯 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>
This PR is for adding a handbook page for describing the process CHAOSS follows for delivering the Community Report.