Skip to content

Commit

Permalink
docs: Use consistent release then record order
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Oct 21, 2024
1 parent 84a27a8 commit 4dea1a6
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Consumes messages published by other software, like Kingfisher Collect.
file_worker
~~~~~~~~~~~

Create records, releases and compiled releases.
Create releases, records and compiled releases.

.. code-block:: bash
Expand All @@ -162,7 +162,7 @@ Errors if the ``ENABLE_CHECKER`` :ref:`environment variable<environment-variable
compiler
~~~~~~~~

Start compilation and route messages to the record or release compilers.
Start compilation and route messages to the release compiler or record compiler.

Performs no work if the collection's ``steps`` field excludes "compile".

Expand Down
12 changes: 6 additions & 6 deletions docs/database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ Database tables
* - ``collection``
- A collection, like the collection of files written to a crawl directory by Kingfisher Collect. See :ref:`db-collection`.
* - ``collection_file``
- A file containing a record package or release package, like the files written by Kingfisher Collect.
- A file containing a release package or record package, like the files written by Kingfisher Collect.
* - ``collection_file_item``
- A passthrough table. `#324 <https://github.com/open-contracting/kingfisher-process/issues/324>`__
* - ``collection_note``
- A collection note. See :ref:`db-collection_note`.
* - ``package_data``
- The metadata for a record package or release package.
- The metadata for a release package or record package.

The metadata is stored separately, to only store one copy of the same metadata within the same collection or across different collections.
* - ``data``
- The data for a record, release or compiled release.
- The data for a release, record or compiled release.

The data is stored separately, to only store one copy of the same data across different collections of the same publication.
* - ``record``
Expand Down Expand Up @@ -180,13 +180,13 @@ WARNING-level notes
See OCDS Kit's `upgrade <https://ocdskit.readthedocs.io/en/latest/cli/ocds.html#upgrade>`__ command.
* - Various
- 🗜
- :ref:`cli-record_compiler` or :ref:`cli-release_compiler` extends the release schema.
- :ref:`cli-release_compiler` or :ref:`cli-record_compiler` extends the release schema.
- An OCDS extension is not retrievable or is invalid UTF-8, JSON or ZIP.

Any merge rules from the extension aren't applied.
* - ``Multiple objects have the `id` value ({key}) in the `{path}` array``
- 🗜
- :ref:`cli-record_compiler` or :ref:`cli-release_compiler` creates a compiled release.
- :ref:`cli-release_compiler` or :ref:`cli-record_compiler` creates a compiled release.
- An array contains objects with the same ID.

Potential data loss, if the duplicates differ.
Expand Down Expand Up @@ -236,7 +236,7 @@ ERROR-level notes
- RabbitMQ message
* - ``OCID {ocid} can't be compiled``
- 🗜
- :ref:`cli-record_compiler` or :ref:`cli-release_compiler` fails to create a compiled release.
- :ref:`cli-release_compiler` or :ref:`cli-record_compiler` fails to create a compiled release.
- The data source doesn't conform to OCDS.
-

Expand Down
2 changes: 1 addition & 1 deletion process/management/commands/addchecks.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def handle_collection(self, collection, *args, **options):
collection.steps.append("check")
collection.save(update_fields=["steps"])

for model, related_name in ((Record, "recordcheck"), (Release, "releasecheck")):
for model, related_name in ((Release, "releasecheck"), (Record, "recordcheck")):
self.stderr.write(
f"Publishing collection files with missing {model.__name__} checks for collection {collection}"
)
Expand Down
2 changes: 1 addition & 1 deletion process/management/commands/compiler.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@


class Command(BaseCommand):
help = w(t("Start compilation and route messages to the record or release compilers"))
help = w(t("Start compilation and route messages to the release compiler or record compiler"))

def handle(self, *args, **options):
consume(
Expand Down
4 changes: 2 additions & 2 deletions process/management/commands/file_worker.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@
routing_key = "file_worker"
logger = logging.getLogger(__name__)

SUPPORTED_FORMATS = {Format.compiled_release, Format.record_package, Format.release_package}
SUPPORTED_FORMATS = {Format.release_package, Format.record_package, Format.compiled_release}
ERROR = CollectionNote.Level.ERROR


class Command(BaseCommand):
help = w(t("Create records, releases and compiled releases"))
help = w(t("Create releases, records and compiled releases"))

def handle(self, *args, **options):
consume(
Expand Down

0 comments on commit 4dea1a6

Please sign in to comment.