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

Format YAML in System Card examples #166

Merged
merged 2 commits into from
Jul 5, 2024

Conversation

robbertbos
Copy link
Member

@robbertbos robbertbos commented Jul 5, 2024

Description

  • Format YAML examples and Markdown formatting
  • Fix mismatches between description and examples
  • Remove comments from YAML examples

Checklist

Please check all the boxes that apply to this pull request using "x":

  • I have tested the changes locally and verified that they work as expected.
  • I have followed the project's coding conventions and style guidelines.
  • I have rebased my branch onto the latest commit of the main branch.
  • I have squashed or reorganized my commits into logical units.
  • I have read, understood and agree to the Developer Certificate of Origin below, which this project utilizes.

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.

@robbertbos robbertbos requested a review from a team as a code owner July 5, 2024 09:28
@robbertbos robbertbos force-pushed the change/change-yaml-in-system-card-examples branch 2 times, most recently from 32326d1 to 6e8b500 Compare July 5, 2024 09:44
@robbertbos robbertbos self-assigned this Jul 5, 2024
Format YAML examples and Markdown formatting
The information is duplicate info, because the info is also available via the section
@robbertbos robbertbos force-pushed the change/change-yaml-in-system-card-examples branch from d06c0b4 to 12f28f6 Compare July 5, 2024 10:05
Copy link
Member

@anneschuth anneschuth left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for doing this!

Is it time to also create a schema?

@robbertbos robbertbos merged commit d0f8a2b into main Jul 5, 2024
4 checks passed
@robbertbos robbertbos deleted the change/change-yaml-in-system-card-examples branch July 5, 2024 14:04
@robbertbos
Copy link
Member Author

#166 (review): Is it time to also create a schema?

@anneschuth, I propose making the schema the first time we need it. At the moment, I still expect that we will make changes, so it would be another location we should keep in mind when making changes to the reporting format.

@anneschuth
Copy link
Member

anneschuth commented Jul 5, 2024

I think we're actually pretty close to needing it. Once MinBZK/amt#72 comes through we'll have the first process that creates system cards. I think we should bake a validation step into that.

I'll create a ticket.

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

Successfully merging this pull request may close these issues.

2 participants