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.

Sign up for GitHub

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

Jump to bottom

Project Documentation #20

Closed
vchrombie opened this issue Aug 10, 2020 · 4 comments
Closed

Project Documentation #20

vchrombie opened this issue Aug 10, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation
Milestone
🪂 Coding Period 3

Comments

@vchrombie
Copy link
Owner

Opening this issue to discuss about the work on the documentation required for the project.
@vchrombie vchrombie added the documentation Improvements or additions to documentation label Aug 10, 2020
@vchrombie vchrombie added this to the 🪂 Coding Period 3 milestone Aug 10, 2020
@vchrombie
Copy link
Owner Author

One good starting point would be Bitergia/prosoul.

Now that we have a workflow with Prosoul and GrimoireLab, we can include the information replacing the old one, here at https://github.com/Bitergia/prosoul/tree/master/doc.
We can update the architecture and workflow diagram too. I have them. @valeriocos helped with these diagrams. 😄

WRT GrimoireLab, the configurations of the enrichers should be updated in chaoss/grimoirelab-sirmordred. I will open a new PR for this.

Do you think we should add some reference or more details regarding the Quality Models or its bunch of enrichers other than these?
Let me know if you have any more suggestions.

@vchrombie vchrombie mentioned this issue Aug 10, 2020
Closed
9 tasks
@valeriocos
Copy link
Collaborator

valeriocos commented Aug 15, 2020 •
edited
Loading

Do you think we should add some reference or more details regarding the Quality Models or its bunch of enrichers other than these?
Let me know if you have any more suggestions

What do you think about adding a README.md in the qm folders within ELK?

@vchrombie
Copy link
Owner Author

Hi @valeriocos

What do you think about adding a README.md in the qm folders within ELK?

That sounds awesome. Do you have anything specific you would be interested to have in the README.md?

@vchrombie
Copy link
Owner Author

vchrombie commented Sep 11, 2021 •
edited
Loading

Bitergia/prosoul#216

glab-prosoul/prosoul

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
🪂 Coding Period 3
Development

No branches or pull requests
2 participants
@valeriocos @vchrombie