Skip to content

Commit

Permalink
docs: Move content about Pelican frontend to that repository
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Jan 26, 2023
1 parent 92c93a4 commit 9aad96d
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 43 deletions.
13 changes: 2 additions & 11 deletions docs/tasks/checks/compiled-release.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
Compiled release-level
======================

Backend
-------

#. Determine the type of check (see :ref:`repository-structure`).
#. Find a check under the corresponding ``contracting_process/resource_level`` sub-directory to copy as a starting point.
#. Add the check to the ``contracting_process/resource_level/definitions.py`` file. For example:
Expand Down Expand Up @@ -57,13 +54,13 @@ An empty ``result`` dict looks like:
:end-at: }

Example
~~~~~~~
-------

.. literalinclude:: ../../../contracting_process/resource_level/coherent/milestone_status.py
:language: python

Storage
~~~~~~~
-------

The results for each item are stored in a single row in the ``resource_level_check`` table. A stored ``result`` value looks like (only two entries in the ``checks`` array are shown):

Expand Down Expand Up @@ -106,9 +103,3 @@ The results for each item are stored in a single row in the ``resource_level_che
}
}
}
Frontend
--------

Pelican frontend automatically supports new compiled release-level checks with known check types.

12 changes: 1 addition & 11 deletions docs/tasks/checks/dataset.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
Dataset-level
=============

Backend
-------

#. Determine the type of check (see :ref:`repository-structure`).
#. Find a check under the corresponding ``dataset`` sub-directory to copy as a starting point.
#. Add the check to the ``dataset/definitions.py`` file. For example:
Expand Down Expand Up @@ -54,13 +51,6 @@ An empty ``result`` dict looks like:
:end-at: }

Storage
~~~~~~~
-------

The result of each check for a given dataset is stored in a single row in the ``dataset_level_check`` table.

Frontend
--------

#. Update ``frontend/src/components/DatasetLevelSection.vue`` and register the check.
#. Register the check in ``frontend/src/plugins/datasetMixins.js``.

12 changes: 2 additions & 10 deletions docs/tasks/checks/field.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
Field-level
===========

Backend
-------

#. Determine the type of check (see :ref:`repository-structure`).
#. Find a check under the corresponding ``contracting_process/field_level`` sub-directory to copy as a starting point.
#. Update the ``_definitions()`` function to assign the check to fields in the ``contracting_process/field_level/definitions.py`` file.
Expand Down Expand Up @@ -33,13 +30,13 @@ An empty ``result`` dict looks like:
:end-at: }

Example
~~~~~~~
-------

.. literalinclude:: ../../../contracting_process/field_level/coverage/exists.py
:language: python

Storage
~~~~~~~
-------

The results for each item are stored in a single row in the ``field_level_check`` table. A stored ``result`` value looks like (only one entry in the ``checks`` array is shown):

Expand Down Expand Up @@ -81,8 +78,3 @@ The results for each item are stored in a single row in the ``field_level_check`
]
}
}
Frontend
--------

Pelican frontend automatically supports new field-level checks.
2 changes: 0 additions & 2 deletions docs/tasks/checks/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Add checks
==========

In all cases, you must update the ``frontend/src/messages/en.js`` file in `Pelican frontend <https://pelican-frontend.readthedocs.io/en/latest/>`__.

.. toctree::
:maxdepth: 1

Expand Down
10 changes: 1 addition & 9 deletions docs/tasks/checks/time-based.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
Time-based
==========

Backend
-------

#. Find a check under the ``time_variance`` directory to copy as a starting point.
#. Add the check to the ``time_variance/definitions.py`` file. For example:

Expand Down Expand Up @@ -40,11 +37,6 @@ The accumulator is initialized as:
:end-at: }

Storage
~~~~~~~
-------

The result of each check for a given dataset is stored in a single row in the ``time_variance_level_check`` table.

Frontend
--------

Pelican frontend automatically supports new time-based checks.

0 comments on commit 9aad96d

Please sign in to comment.