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

Capability map update - spec v0.2 candidate #115

Merged
merged 32 commits into from
Jun 28, 2023

Conversation

edwardchalstrey1
Copy link
Contributor

@edwardchalstrey1 edwardchalstrey1 commented Jun 23, 2023

✅ Checklist

  • This pull request has a meaningful title.
  • If your changes are not yet ready to merge, you have marked this pull request as a draft pull request.

☑️ Maintainers' checklist

  • This pull request has had the appropriate labels assigned
  • This pull request has been added to the SATRE backlog project board
  • This pull request has been assigned to one or more maintainers

⤴️ Summary

  • Changes the capability map to a draw.io for easy editing
  • Adds sections of capability map to pillars pages
  • Adds "Internal Audit" and "Reporting" headers from @machintim WP3 spreadsheet
  • Adds various capabilities to the text that were missing, based off the capability map; Note: these haven't been filled in

TODO:

  • Match the capability map to the actual headers in the text

🌂 Related issues

🙋 Acknowledging contributors

@edwardchalstrey1 edwardchalstrey1 marked this pull request as ready for review June 26, 2023 13:48
@edwardchalstrey1
Copy link
Contributor Author

How were the colours chosen? Are they colour-bind safe?

I don't think they look very attractive, and they stand out from the theme.

To add to @manics's point, I'm not very keen on the idea that changing the spec also requires editing, at least, two images.

I could use a blue/black/white theme similar to the readthedocs

Perhaps for now then I'll just have the full capability map on each pillars page, then someone can use Mermaid in a subsequent PR if they want

@JimMadge
Copy link
Member

Is there a mermaid figure type that would work?
Could hack something like this but it doesn't look great.

graph TD;
  subgraph 1. Information Governance
     subgraph Project Management
         a(Project Onboarding)
         b(Project Closure)
         c(Roles and Responsibilities)
     end
     subgraph Risk Management
     end
  end
Loading

Would dot/graphviz do what we want?

@edwardchalstrey1
Copy link
Contributor Author

worth noting that sticking to draw.io means we can easily modify graphics made by @machintim

@edwardchalstrey1
Copy link
Contributor Author

based on Tim's comments on Teams, I think we should merge this now and make subsequent PRs for specific capability definition updates/deletions/additions

@jemrobinson
Copy link
Contributor

jemrobinson commented Jun 27, 2023

based on Tim's comments on Teams, I think we should merge this now and make subsequent PRs for specific capability definition updates/deletions/additions

Let's discuss in this afternoon's meeting

@edwardchalstrey1
Copy link
Contributor Author

edwardchalstrey1 commented Jun 27, 2023

Based on the WP1 discussion today I will likely:

  1. Remove blank headers (including all of Supporting capabilities) from this PR
  2. Make some separate PRs for each capability with Tim's one sentence summaries (maybe just one for Supporting capabilities)
  3. @harisood can flesh out some of the supporting capabilities

@edwardchalstrey1
Copy link
Contributor Author

This PR should now be ready to merge

@harisood
Copy link
Member

worth noting that sticking to draw.io means we can easily modify graphics made by @machintim

Agreed that draw.io is the easiest barrier to access for collaborative diagrams for anyone looking to make an update, can also be v flexbile on colours, shapes etc

@manics
Copy link
Member

manics commented Jun 27, 2023

If you run pre-commit run -a this should be fine to merge

Copy link
Contributor

@jemrobinson jemrobinson left a comment

Choose a reason for hiding this comment

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

I'm not sure this is quite right. We had some capabilities under the "supporting" pillar before, but there just wasn't much there. I don't think removing the pillar completely is correct.

If you'd like, I can add a couple of bullet points to them?

@edwardchalstrey1
Copy link
Contributor Author

I'm not sure this is quite right. We had some capabilities under the "supporting" pillar before, but there just wasn't much there. I don't think removing the pillar completely is correct.

If you'd like, I can add a couple of bullet points to them?

@jemrobinson I'm planning to make a PR that adds the supporting pillar back, where each capabilities tables can also be filled in - would it make sense for you to add your thoughts there? None of the capabilities in supporting had the table properly filled out yet

@edwardchalstrey1 edwardchalstrey1 changed the title Capability map update Capability map update - spec v0.2 candidate Jun 27, 2023
@edwardchalstrey1 edwardchalstrey1 merged commit 7ed1909 into main Jun 28, 2023
6 checks passed
@edwardchalstrey1 edwardchalstrey1 deleted the capability-map-update branch June 28, 2023 10:00
@edwardchalstrey1
Copy link
Contributor Author

I'm not sure this is quite right. We had some capabilities under the "supporting" pillar before, but there just wasn't much there. I don't think removing the pillar completely is correct.
If you'd like, I can add a couple of bullet points to them?

@jemrobinson I'm planning to make a PR that adds the supporting pillar back, where each capabilities tables can also be filled in - would it make sense for you to add your thoughts there? None of the capabilities in supporting had the table properly filled out yet

See #117

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants