Skip to content

Commit

Permalink
ignore schema doc from spelling check
Browse files Browse the repository at this point in the history
  • Loading branch information
tang-mm committed Dec 6, 2023
1 parent dfc2a45 commit e035fd5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/.sphinx/spellingcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ matrix:
- .sphinx/wordslist.txt
output: .sphinx/.wordlist.dic
sources:
- _build/**/*.html
- _build/**/*.html|!_build/reference/submission-schema/*
pipeline:
- pyspelling.filters.html:
comments: false
Expand Down
7 changes: 3 additions & 4 deletions docs/reference/submission-schema.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
Submission Schema
==================

Checkbox :ref:`Submission files <submission-files>` provide a summary of the test results and in-depth information that help analyzing the tests.
Checkbox :ref:`submissions <submission-files>` contain reports of the tests and in-depth information that helps analyzing the test results. These files are sent to the :term:`Certification Website` for sharing test results.

This document describes the schema the ``submission.json`` files that's sent to the `Certification website <https://certification.canonical.com>`_ as part of the submission. To get the latest schema definition file in Json, go to the Checkbox `GitHub repository <https://github.com/canonical/checkbox/blob/main/submission-schema/schema.json>`_.
This document describes the schema of the ``submission.json`` files as part of the submission. To get the latest JSON schema file, go to the Checkbox `GitHub repository <https://github.com/canonical/checkbox/blob/main/submission-schema/schema.json>`_.

.. important::

The schema described in this document is work-in-progress and being reviewed. If you need assistance in validating the schema, please contact the Checkbox team.

.. jsonschema:: ../../submission-schema/schema.json
:lift_definitions:
:auto_reference:

0 comments on commit e035fd5

Please sign in to comment.