Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Tidy up specification for point release #189

Merged
merged 5 commits into from
Aug 10, 2023

Conversation

jemrobinson
Copy link
Contributor

@jemrobinson jemrobinson commented Aug 10, 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

  • Add links to business process/application component/data object glossary definitions
  • Tidy up second-level headings
  • Add numbering

🌂 Related issues

🙋 Acknowledging contributors

Copy link
Member

@JimMadge JimMadge left a comment

Choose a reason for hiding this comment

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

I don't like the DIY subsections using bold text for each capability component. Using headings gives us styling and cross referencing for free. This was moves burden to us to keep the style consistent and create labels where we need them.

What is the problem with using headings?

(I'm glad we got rid of the italic paragraphs though 🧐)

@jemrobinson jemrobinson changed the title Link to component categories Tidy up specification for point release Aug 10, 2023
@jemrobinson
Copy link
Contributor Author

jemrobinson commented Aug 10, 2023

What is the problem with using headings?

With our current settings ({toctree} :numbered:), headings get automatic numbering. We don't want capability components to have numbers. If you'd prefer, I can remove this setting and add manual numbers but restore the capability component as headings.

@jemrobinson jemrobinson requested a review from a team August 10, 2023 10:29
@jemrobinson
Copy link
Contributor Author

@sa-tre/spec-maintainers: we should get whatever style changes we decide on merged by the end of the day so we can tag v0.3 and start evaluating against it.

@jemrobinson jemrobinson added proposed change A proposed change to the specification pillar: information governance Information governance pillar pillar: computing technology Computing technology pillar pillar: data management Data management pillar pillar: supporting Supporting capabilities labels Aug 10, 2023
@jemrobinson jemrobinson requested a review from JimMadge August 10, 2023 10:31
@JimMadge
Copy link
Member

@jemrobinson We should be able to give an argument to :numbered: to set what level to number headings to.

I think here we want :numbered: 2.

@jemrobinson jemrobinson merged commit e593da9 into main Aug 10, 2023
@manics manics deleted the link-to-component-categories branch October 12, 2023 08:11
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
pillar: computing technology Computing technology pillar pillar: data management Data management pillar pillar: information governance Information governance pillar pillar: supporting Supporting capabilities proposed change A proposed change to the specification
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants