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

Automate creation of the GQM diagram #37

Closed
4 of 5 tasks
rrrutledge opened this issue Oct 6, 2023 · 12 comments · Fixed by #55 or #53
Closed
4 of 5 tasks

Automate creation of the GQM diagram #37

rrrutledge opened this issue Oct 6, 2023 · 12 comments · Fixed by #55 or #53
Assignees

Comments

@rrrutledge
Copy link
Contributor

rrrutledge commented Oct 6, 2023

  • Add a README.md
  • Merge PR, initial version
  • Add test coverage & test coverage reporting.
  • Add to github pipeline.
  • Merge PR, final version
@rrrutledge rrrutledge converted this from a draft issue Oct 6, 2023
@jeffabailey
Copy link
Collaborator

  1. A command is created that generates the graph of issue.
  2. The command creates a mermaid diagram from the graph.

@spier
Copy link
Member

spier commented Oct 21, 2023

Which diagram do you want to auto-generate?
And what should be used as input data for this generation?

@jeffabailey
Copy link
Collaborator

The mermaid diagram.
The markdown files.

Here's a first stab at a solution.

https://github.com/jeffabailey/gqm_gen

npm i && npm run start

It should generate:

```mermaid
graph LR
Goal1((Goal1))
Question1{Question2}
Metric1((Metric1))
Goal4((Goal4))
Goal1-->Question1
Goal1-->Metric1
Question1-.->Metric1
Metric1==>Goal1

It's not done, but sharing the code early.

Do we want to put this code somewhere in particular?

@rrrutledge
Copy link
Contributor Author

Ideally in the repo somewhere - if we put it in something like a “scripts” folder will GitBook try to deploy it?

@spier
Copy link
Member

spier commented Oct 27, 2023

gitbook will only include the files in the book that are listed in SUMMARY.md

@spier
Copy link
Member

spier commented Oct 27, 2023

I am still unclear what is being discussed here though.

With GQM diagram, you mean this one here, right?
https://innersourcecommons.gitbook.io/managing-innersource-projects/measuring/goals/use_gqm

Why do you want to generate the GQM diagram automatically?

@rrrutledge
Copy link
Contributor Author

It is a philosophy - that in general mechanical, repetitive tasks should be automated to save time and errors.

@spier
Copy link
Member

spier commented Oct 28, 2023

Yeah, I figured the bit about the philosophy.

Maybe the mission context is this:
Are you expecting to add a lot of Goals, Questions, and Metrics to that graph over time?

@rrrutledge
Copy link
Contributor Author

Hope so! We know that there are so many out there that people have talked about that aren’t added here.

https://miro.com/app/board/uXjVM3USbSE=/

@jeffabailey jeffabailey linked a pull request Nov 6, 2023 that will close this issue
@jeffabailey
Copy link
Collaborator

I'll get around to finishing this either this week, or the last week of November.

@rrrutledge
Copy link
Contributor Author

Thank you, @jeffabailey

@github-project-automation github-project-automation bot moved this from In Progress to Internal in ISPO Working Group Dec 1, 2023
@dellagustin-sap dellagustin-sap moved this from Internal to Done in ISPO Working Group Dec 4, 2023
@dellagustin-sap dellagustin-sap moved this from Done to Internal in ISPO Working Group Dec 4, 2023
@dellagustin-sap
Copy link
Contributor

Closed automatically by the PR, but there are still open points.

@dellagustin-sap dellagustin-sap moved this from Internal to In Progress in ISPO Working Group Dec 4, 2023
@jeffabailey jeffabailey linked a pull request Dec 16, 2023 that will close this issue
@rrrutledge rrrutledge moved this from In Progress to Proposed in ISPO Working Group Dec 18, 2023
@github-project-automation github-project-automation bot moved this from Proposed to Adopted in ISPO Working Group Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment