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

Restructure introduction to specification #106

Merged
merged 13 commits into from
Jun 21, 2023
Merged

Conversation

harisood
Copy link
Member

✅ 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

Refactor the introduction to the specification with our current version of the architecture, including visualisations

🌂 Related issues

🙋 Acknowledging contributors

  • All contributors to this pull request are already named in the table of contributors in the README file.

@harisood harisood added the proposed change A proposed change to the specification label Jun 20, 2023
@harisood
Copy link
Member Author

Is this the right kind of thing?

If so work to come out of this:

  • Update the principles as in line with @machintim 's latest architecture doc
  • Refactor capabilities to match visualisations (e.g. for IG there are now only 4 capabilities, but in the specification there are 6 and the titles do not match)

@harisood
Copy link
Member Author

FYI this diagram is a refactor of @machintim 's original based on my understanding/what I think might be a bit clearer!

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.

LGTM subject to questions inline

@harisood
Copy link
Member Author

@jemrobinson made edits, will leave open for a little bit to see if others have thoughts. Feel free to merge without me if not done today!

docs/images/.DS_Store Outdated Show resolved Hide resolved
docs/source/standard.md Show resolved Hide resolved
docs/source/standard.md Outdated Show resolved Hide resolved
docs/source/standard.md Outdated Show resolved Hide resolved
docs/source/standard.md Outdated Show resolved Hide resolved
docs/source/standard.md Outdated Show resolved Hide resolved
docs/source/standard.md Outdated Show resolved Hide resolved
docs/source/standard.md Outdated Show resolved Hide resolved
docs/source/standard.md Outdated Show resolved Hide resolved
docs/source/standard.md Outdated Show resolved Hide resolved
@JimMadge
Copy link
Member

As @harisood is away I will make the changes I've suggested above. However, please do say if you disagree because those are just my opinions after all.

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.

If we want to restructure into three capabilities, shouldn't we also renumber the sections below?

docs/source/standard.md Outdated Show resolved Hide resolved
Co-authored-by: Matt Craddock <monklefish@gmail.com>
@JimMadge
Copy link
Member

If we want to restructure into three capabilities, shouldn't we also renumber the sections below?

Yes. Do you think it is in scope for this PR?

Longer term, do we think that part will be on a separate page?
It would be nice if we could use automatic numbering so that the references can come out like "Capability 1.3.4".

@jemrobinson
Copy link
Contributor

If we want to restructure into three capabilities, shouldn't we also renumber the sections below?

Yes. Do you think it is in scope for this PR?

I'm happy to do this in a follow-on PR.

@jemrobinson jemrobinson merged commit ed1f7be into sa-tre:main Jun 21, 2023
3 checks passed
@jemrobinson jemrobinson mentioned this pull request Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposed change A proposed change to the specification
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants