Skip to content

Commit

Permalink
docs: Merge OCDS Show into Architecture. Copy-edit headings.
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Jan 18, 2024
1 parent 1a706e8 commit 9f58504
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 24 deletions.
10 changes: 7 additions & 3 deletions docs/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ cove-ocds

``cove_project/`` contains the Django components (settings, URL paths, server).


lib-cove-ocds
-------------

Expand All @@ -34,8 +33,13 @@ The OCDS Data Review Tool is just one manifestation of software historically kno
* lib-cove-web (`opendataservices/lib-cove-web <https://github.com/opendataservices/lib-cove-web>`_): provides a barebones Django configuration, and baseline CSS, JS and templates that are common for all CoVE instances. It is also a place for common functions relating to presentation or display of data or output. Any templates edited here typically affect all CoVE instances. Sometimes this is useful, but for OCDS-only changes, templates can be overridden in cove-ocds. This and cove-ocds are the only places where frontend output and translatable strings should be.
* flatten-tool (`opendataservices/flatten-tool <https://github.com/opendataservices/flatten-tool>`_): a general purpose library for converting data between JSON and CSV/XLS formats. While not CoVE-specific, it is listed here because it is a specialized tool of which the DRT makes heavy use.

Config
------
OCDS Show
---------

`OCDS Show <https://github.com/open-contracting/ocds-show>`_ is a JavaScript application for embedding visualizations of OCDS data. The DRT generates data for OCDS Show in ``views.py`` so that it can be embedded in the ``explore_`` templates. Additional functions to help with the data generation for OCDS show are in ``cove_ocds/lib/ocds_show_extra.py``.

Configuration
-------------

Some configuration variables are set in ``COVE_CONFIG``, found in ``cove_project/settings.py``.

Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-add-kfi.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
How to add to Key Field Information
===================================
How to add key field information
================================

Key Field Information is a summary of key statistics about the data that's been provided.

Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-config-frontend.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
How to replace something hardcoded in the frontend with a configurable variable
================================================================================
How to replace frontend hardcoding with a configurable variable
===============================================================

Pick a name for the environment variable you want to configure cove with. In this example we use `MY_ENV_VAR`.

Expand Down
12 changes: 2 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
OCDS Data Review Tool: Developer Documentation
==============================================
OCDS Data Review Tool
=====================

.. include:: ../README.rst

Expand All @@ -20,7 +20,6 @@ The `CoVE <https://cove.readthedocs.io/en/latest/>`__ documentation might also b
how-to-config-frontend
how-to-add-kfi
tests
ocds-show

There are `drafts <https://docs.google.com/document/d/1EER_GjXi7F0SPZ_Mra9JuQBY5JxU0NGRSS9mYzB4guU/edit>`__ of another couple how-tos for adding headlines and modifying validation error messages.

Expand Down Expand Up @@ -56,10 +55,3 @@ This will make the test site available on the local machine only. If you are run
ALLOWED_HOSTS='XXX.XXX.XXX.XXX' python manage.py runserver 0.0.0.0:8000
where XXX.XXX.XXX.XXX is the IP address that you'll be using to access the running service.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
8 changes: 1 addition & 7 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1 @@
-r ../requirements.txt
# sphinx>=4.4.0 requires importlib-metadata>=4.4, but django-bootstrap3 requires <3.
# https://github.com/zostera/django-bootstrap3/issues/608
# https://github.com/zostera/django-bootstrap4/issues/380
sphinx<4.4.0
# sphinx<4.4.4 requires a specific version of furo.
furo==2022.4.7
furo

0 comments on commit 9f58504

Please sign in to comment.