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.

Sign up for GitHub

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

Jump to bottom

update Readme in submission schema about documentation (infra) #1161

Merged
merged 2 commits into from
May 7, 2024
Merged

update Readme in submission schema about documentation (infra) #1161

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5580db
update Readme with notes
tang-mm Apr 9, 2024
e934353
Apply comments
tang-mm Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions submission-schema/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,17 @@ In this folder you can find the schema for the submission.json that's sent to ce

`schema.json` contains the schema that was generated using ~2000 latest (at the time of writing) submissions uploaded to C3.

This json file is referenced by the `docs/reference/submission-schema.rst` file, which is used to generate the
[submission schema reference documentation](https://checkbox.readthedocs.io/en/latest/reference/submission-schema.html).
Changes in the schema are reflected after successful documentation build.

## Generating schema from scratch

The `schema.json` can be generated using a existing submission tarballs.
Follow the steps below to generate a fresh `schema.json`

> The schema generator is really a utility that helps (helped) create a _starting point_ for the submission JSON schema, and is not for continued use more so than diagnostic purposes (using it serves the purpose of comparing actual submission data against the schema in use, but it is not for example intended to be used regularly to update the canonical schema.json in this directory).

### Obtaining submission tarballs

If you have access to the Hexr repository, you will find a useful
Expand Down
Loading