From 2e406ac9df00a08b79f94fb49a46127248e90544 Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Sat, 27 Apr 2024 17:17:34 -0400 Subject: [PATCH] docs: Move unimplemented admin features from sysadmin to siteadmin --- docs/admin/siteadmin.rst | 18 ++++++++++++++++++ docs/admin/sysadmin.rst | 36 ++++++++++-------------------------- 2 files changed, 28 insertions(+), 26 deletions(-) diff --git a/docs/admin/siteadmin.rst b/docs/admin/siteadmin.rst index 3ca830f..b2a3b8f 100644 --- a/docs/admin/siteadmin.rst +++ b/docs/admin/siteadmin.rst @@ -95,6 +95,24 @@ A job's detail page: This project's RabbitMQ management interface is at `rabbitmq.data.open-contracting.org `__. +.. _admin-cancel: + +Cancel a job +~~~~~~~~~~~~ + +A job can stall (always "running"). The only option is to `cancel `__ the Scrapyd job and set the job's *Status* to *COMPLETED* using the `Django admin `__. + +.. attention:: + + To properly implement this feature, see `#352 `__. + +Restart a task +~~~~~~~~~~~~~~ + +.. attention:: + + To properly implement this feature, see `#354 `__ (for retryable tasks) and `#350 `__ (for non-retryable tasks). + Unpublish or freeze a publication --------------------------------- diff --git a/docs/admin/sysadmin.rst b/docs/admin/sysadmin.rst index 901088c..6daedd0 100644 --- a/docs/admin/sysadmin.rst +++ b/docs/admin/sysadmin.rst @@ -62,45 +62,29 @@ All containers log to standard output, which can be `read as usual using Docker :ref:`Troubleshooting for site administrators` -.. _admin-cancel: - -Cancel a job -~~~~~~~~~~~~ - -A job can stall (always "running"). The only option is to `cancel `__ the Scrapyd job and set the job's *Status* to *COMPLETED* using the `Django admin `__. - -.. attention:: - - To properly implement this feature, see `#352 `__. - -Restart a task -~~~~~~~~~~~~~~ - -.. attention:: - - To properly implement this feature, see `#354 `__ (for retryable tasks) and `#350 `__ (for non-retryable tasks). - Debug another application ~~~~~~~~~~~~~~~~~~~~~~~~~ Kingfisher Collect `Use Kingfisher Collect locally `__. Kingfisher Process - Download the data from crawl directory in the ``KINGFISHER_COLLECT_FILES_STORE`` directory, and run Kingfisher Process' ``load`` `command `__. + - Download the data from crawl directory in the ``KINGFISHER_COLLECT_FILES_STORE`` directory. + - Run Kingfisher Process' ``load`` `command `__. Pelican - Open an SSH tunnel to forward the PostgreSQL port: + - Open an SSH tunnel to forward the PostgreSQL port: - .. code-block:: bash + .. code-block:: bash - ssh -N ssh://root@ocp13.open-contracting.org:2223 -L 65432:localhost:5432 + ssh -N ssh://root@ocp13.open-contracting.org:2223 -L 65432:localhost:5432 - Run Pelican backend's ``add`` `command `__: + - Run Pelican backend's ``add`` `command `__: - .. code-block:: bash + .. code-block:: bash - env KINGFISHER_PROCESS_DATABASE_URL=postgresql://pelican_backend:PASSWORD@localhost:65432/kingfisher_process ./manage.py add SPIDER_YYYY-MM-DD ID + env KINGFISHER_PROCESS_DATABASE_URL=postgresql://pelican_backend:PASSWORD@localhost:65432/kingfisher_process ./manage.py add SPIDER_YYYY-MM-DD ID Flattener - Download the data from the job's directory in the ``EXPORTER_DIR`` directory, and run the `flatterer `__ command locally. + - Download the data from the job's directory in the ``EXPORTER_DIR`` directory. + - Run the `flatterer `__ command locally. Reset other applications ~~~~~~~~~~~~~~~~~~~~~~~~