From bfc61b27b6b40eb473d6e7ec08d6a1ee7023c404 Mon Sep 17 00:00:00 2001 From: Duncan Dewhurst Date: Tue, 12 Dec 2023 11:51:08 +1300 Subject: [PATCH 1/2] docs/profiles/infrastructure.rst: Add new commands --- docs/profiles/infrastructure.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/profiles/infrastructure.rst b/docs/profiles/infrastructure.rst index 5fcba41..ed6e602 100644 --- a/docs/profiles/infrastructure.rst +++ b/docs/profiles/infrastructure.rst @@ -65,3 +65,30 @@ You can then: - Edit the workbook in your preferred spreadsheet software - Export each sheet as a CSV file to the ``mapping`` directory + + +Update sustainability.yaml +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +For each change to the [CoST IDS sustainability elements](https://docs.google.com/spreadsheets/d/165epI69oQ5YyL4-2q8VubFn9VuNham2Pi1u0P49id9o/), run: + +.. code-block:: shell + + ./manage.py update-sustainability-elements + +Update sustainability.md +~~~~~~~~~~~~~~~~~~~~~~~~ + +For each change to `mapping/sustainability.yaml`: + +1. Lint the YAML file and link field names to the schema reference documentation: + +.. code-block:: shell + + ./manage.py lint -l mapping/sustainability.yaml + +2. Update the associated Markdown page: + +.. code-block:: shell + + ./manage.py update-sustainability-docs From be5989027b06d238fa3c25c41c02b3c9b4fbc4f7 Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Mon, 11 Dec 2023 18:09:59 -0500 Subject: [PATCH 2/2] chore: Use RST syntax --- docs/profiles/infrastructure.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/profiles/infrastructure.rst b/docs/profiles/infrastructure.rst index ed6e602..1fd77b5 100644 --- a/docs/profiles/infrastructure.rst +++ b/docs/profiles/infrastructure.rst @@ -66,11 +66,10 @@ You can then: - Edit the workbook in your preferred spreadsheet software - Export each sheet as a CSV file to the ``mapping`` directory - Update sustainability.yaml ~~~~~~~~~~~~~~~~~~~~~~~~~~ -For each change to the [CoST IDS sustainability elements](https://docs.google.com/spreadsheets/d/165epI69oQ5YyL4-2q8VubFn9VuNham2Pi1u0P49id9o/), run: +For each change to the `CoST IDS sustainability elements `__, run: .. code-block:: shell @@ -79,15 +78,15 @@ For each change to the [CoST IDS sustainability elements](https://docs.google.co Update sustainability.md ~~~~~~~~~~~~~~~~~~~~~~~~ -For each change to `mapping/sustainability.yaml`: +For each change to ``mapping/sustainability.yaml``: -1. Lint the YAML file and link field names to the schema reference documentation: +1. Lint it, and link any field names to the schema reference documentation: .. code-block:: shell ./manage.py lint -l mapping/sustainability.yaml -2. Update the associated Markdown page: +2. Update ``docs/cost/ids/sustainability.md``: .. code-block:: shell