Adds modified script and rst files

openrepair · Dec 21, 2020 · e0960c9 · e0960c9
1 parent b5c7c02
commit e0960c9
Show file tree

Hide file tree

Showing 9 changed files with 356 additions and 468 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,8 @@ More information available at the [OpenRepair website](https://openrepair.org/op
 
 A "docx" format file in the root folder. A Google document may be exported as "docx".
 
-A "pdf" format file in the _pdf folder. A Google document may be exported as "pdf".
+A "pdf" format file in the _pdf folder. A Google document may be exported as "pdf". 
+Amend the link to the pdf file in _templates/layout.html.
 
 Each section in the docx file should begin with a string that matches this regex: `^Section [1-9]: ` 
 

diff --git a/_pdf/README.md b/_pdf/README.md
@@ -1,5 +1,7 @@
-PDF file and doctree will be generated in this folder.
+Place a "pdf" format file in this folder. 
 
-$ `sphinx-build -b pdf ./ ./_pdf`
+A Google document may be exported as "pdf".
 
-Rename and copy the pdf file to `./_build/html/`
+Amend the link to the pdf file in _templates/layout.html.
+
+After running `make html` copy the pdf file to `./_build/html/pdf`
diff --git a/_templates/layout.html b/_templates/layout.html
@@ -8,7 +8,7 @@
 <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
     <div>
         <p><span class="fa fa-book">&nbsp;Version 0.2</span></p>        
-        <p><a href="pdf/OpenRepairDataStandardv0.2.pdf" target="_blank">PDF</a></p>
+        <p><a href="pdf/Open Repair Data Standard v0.2.pdf" target="_blank">PDF</a></p>        
         <p><a href="https://openrepair.org" target="_blank">Open Repair Alliance</a></p>
     </div>
 </div>

diff --git a/about.rst b/about.rst
@@ -6,8 +6,8 @@ Goals and ORDS use cases
 ------------------------
 
 The initial objective of the Open Repair Alliance is to help
-organisations involved in community repair to better harmonise the way
-we collect and share information about successes and challenges in
+organisations involved in community repair to harmonise the way we
+collect and share information about successes and challenges in
 repairing small electrical and consumer electronic devices, to increase
 the visibility and the impact of the work we all do.
 

diff --git a/document.rst b/document.rst
@@ -7,10 +7,10 @@ Version
 
 *Number:* 0.2
 
-*Description*: Initial version agreed by Open Repair Alliance founding
-members
+*Description*: Updated version agreed by Open Repair Alliance founding
+members, based on analysis and aggregation of data provided by partners
 
-*Published*: DD MM 2020
+*Published*: 21 12 2020
 
 *Authors:* The Restart Project
 
@@ -27,172 +27,20 @@ Changelog
 ***V0.1*** - Initial version agreed by Open Repair Alliance founding
 members, published on 14 November 2017
 
-***V0.2*** - October 2020.
+***V0.2*** - Published December 2020, including updates based on
+analysis and aggregation of data provided by partners
 
 -  Recommended options for *repair\_status*
 
--  Additions to *product\_category* values
+-  Recommended options for *product\_category* values
 
--  Addition of *partner\_category* field
+-  Addition of *partner\_product\_category* field
 
 -  Addition of *repair\_barrier* field
 
 -  Addition of *country* field
 
-Appendix A - Repair status
---------------------------
-
-This appendix outlines the repair statuses currently collected by
-partner organisations, and how they map to the ORDS values.
-
-**ORDS**
-
-+---------------+
-| Fixed         |
-+===============+
-| Repairable    |
-+---------------+
-| End of life   |
-+---------------+
-| Unknown       |
-+---------------+
-
-**Restart Project**
-
-Mapped from column “Repair Status”
-
-+---------------------+-------------------+
-| **Repair Status**   | **ORDS Status**   |
-+=====================+===================+
-| Fixed               | Fixed             |
-+---------------------+-------------------+
-| Repairable          | Repairable        |
-+---------------------+-------------------+
-| End of life         | End-of-life       |
-+---------------------+-------------------+
-| Unknown             | Unknown           |
-+---------------------+-------------------+
-
-**Repair Cafe Foundation**
-
-Column: “Gerepareerd, ja, half/advies, nee” (“Repaired, yes, half /
-advice, no”)
-
-+-----------------------------+------------------------------+-------------------+
-| **Dutch**                   | **English**                  | **ORDS Status**   |
-+=============================+==============================+===================+
-| Nee                         | No                           | Unknown           |
-+-----------------------------+------------------------------+-------------------+
-| Ja                          | Yes                          | Fixed             |
-+-----------------------------+------------------------------+-------------------+
-| Half en/of advies gegeven   | Half and / or advice given   | Repairable        |
-+-----------------------------+------------------------------+-------------------+
-
-**anstiftung**
-
-Repair status is determined by evaluating the content of a number of
-fields.
-
-+---------------------------+---------------+---------------------+
-| **defect\_found\_name**   |               |                     |
-+===========================+===============+=====================+
-| **German**                | **English**   | **Repair Status**   |
-+---------------------------+---------------+---------------------+
-| ja                        | yes           | (reason...)         |
-+---------------------------+---------------+---------------------+
-| nein                      | no            | Unknown             |
-+---------------------------+---------------+---------------------+
-
-+-------------------------------------------------+----------------------------------------------+---------------------+
-| **defect\_found\_reason**                       |                                              |                     |
-+=================================================+==============================================+=====================+
-| **German**                                      | **English**                                  | **Repair Status**   |
-+-------------------------------------------------+----------------------------------------------+---------------------+
-| Abbruch: Gerät darf nicht mehr genutzt werden   | Cancellation: Device may no longer be used   | Unknown             |
-+-------------------------------------------------+----------------------------------------------+---------------------+
-| erfolgreich abgeschlossen                       | successfully completed                       | Fixed               |
-+-------------------------------------------------+----------------------------------------------+---------------------+
-| nicht erfolgt, weil...                          | not done, because ...                        | (reason…)           |
-+-------------------------------------------------+----------------------------------------------+---------------------+
-| vertagt, weil...                                | adjourned because ...                        | (reason...)         |
-+-------------------------------------------------+----------------------------------------------+---------------------+
-| NULL                                            | NULL                                         | Unknown             |
-+-------------------------------------------------+----------------------------------------------+---------------------+
-
-+----------------------------------------+------------------------------------+---------------------+
-| **repair\_postponed\_reason**          |                                    |                     |
-+========================================+====================================+=====================+
-| **German**                             | **English**                        | **Repair Status**   |
-+----------------------------------------+------------------------------------+---------------------+
-| Ersatzteilbesorgung durch Besucher     | Spare parts for visitors           | Repairable          |
-+----------------------------------------+------------------------------------+---------------------+
-| Ersatzteilbesorgung durch Reparateur   | Spare parts by repairer            | Repairable          |
-+----------------------------------------+------------------------------------+---------------------+
-| Hilfsmittel oder Zubehör fehlt         | Tools or accessories are missing   | Repairable          |
-+----------------------------------------+------------------------------------+---------------------+
-| NULL                                   | NULL                               | Repairable          |
-+----------------------------------------+------------------------------------+---------------------+
-
-+----------------------------------+------------------------------------+---------------------+
-| **no\_repair\_reason**           |                                    |                     |
-+==================================+====================================+=====================+
-| **German**                       | **English**                        | **Repair Status**   |
-+----------------------------------+------------------------------------+---------------------+
-| Ersatzteil nicht erhältlich      | Spare part not available           | Unknown             |
-+----------------------------------+------------------------------------+---------------------+
-| Gerät nicht komplett             | Device not complete                | Unknown             |
-+----------------------------------+------------------------------------+---------------------+
-| Gesamtaufwand zu hoch            | Total effort too high              | End of life         |
-+----------------------------------+------------------------------------+---------------------+
-| hat noch Garantie                | still has warranty                 | Repairable          |
-+----------------------------------+------------------------------------+---------------------+
-| Hilfsmittel oder Zubehör fehlt   | Tools or accessories are missing   | Repairable          |
-+----------------------------------+------------------------------------+---------------------+
-| Sonstiges                        | miscellaneous                      | End of life         |
-+----------------------------------+------------------------------------+---------------------+
-| Teilnutzung möglich              | Partial use possible               | Repairable          |
-+----------------------------------+------------------------------------+---------------------+
-| zu lange Wartezeit               | too long wait                      | Unknown             |
-+----------------------------------+------------------------------------+---------------------+
-| NULL                             | NULL                               | End of life         |
-+----------------------------------+------------------------------------+---------------------+
-
-+-------------------------------------------------+-----------------+---------------------+
-| **device\_must\_not\_be\_used\_anymore \*\***   |                 |                     |
-+=================================================+=================+=====================+
-| **German**                                      | **English**     | **Repair Status**   |
-+-------------------------------------------------+-----------------+---------------------+
-| NULL                                            | NULL            |                     |
-+-------------------------------------------------+-----------------+---------------------+
-| *<not empty>*                                   | *<not empty>*   | End of life         |
-+-------------------------------------------------+-----------------+---------------------+
-
-\*\* The field \`device\_must\_not\_be\_used\_anymore\` was found to
-have no values other than NULL. The assumption is that if a value was to
-be found that the \`repair\_status\` would then be “End of life”.
-
-|image0|
-
-**Fixit Clinic**
-
-Mapped from column “At this point: what's the disposition of this
-item?”, containing a number of unique, white-space trimmed values. As
-free-text can be entered, a number of these are not mappable
-automatically - those that can are listed below.
-
-+-------------------------------------------+---------------------+
-| **Original**                              | **Repair Status**   |
-+===========================================+=====================+
-| Fixed (hooray!)                           | Fixed               |
-+-------------------------------------------+---------------------+
-| Repairable and I’m going to keep trying   | Repairable          |
-+-------------------------------------------+---------------------+
-| Unserviceable (End-of-Life)               | End of life         |
-+-------------------------------------------+---------------------+
-| End-of-Life                               | End of life         |
-+-------------------------------------------+---------------------+
-| Unknown                                   | Unknown             |
-+-------------------------------------------+---------------------+
-
-.. |image0| image:: media/image1.png
-   :width: 6.27083in
+-  Removal of *model* field due to problems with data collection and quality
+
+-  Removal of “additional modules” section
+
diff --git a/governance.rst b/governance.rst
@@ -21,14 +21,14 @@ The work of the Alliance is facilitated by a coordinator organisation,
 The Restart Project, as of November 2017. This role is open to other
 members should they wish to participate or collaborate.
 
-Additional membership
----------------------
-
-Membership is open to other organisations and individuals interested and
-active in issues around repair. These include: consumer rights
-organisations, environmental NGOs, networks and universities. The
-rationale for their involvement is to seek advice, support and insights
-from groups which might also benefit from our work.
+Membership
+----------
+
+Membership is open to other organisations interested and active in
+issues around repair. These include: consumer rights organisations,
+environmental NGOs, networks and universities. The rationale for their
+involvement is to seek advice, support and insights from groups which
+might also benefit from our work.
 
 Decision making
 ---------------

diff --git a/media/image1.png b/media/image1.png
diff --git a/prepare.sh b/prepare.sh
@@ -3,7 +3,7 @@
 case $1 in
 	-file ) infile=$2	
 			;;
-	--help | * ) 	echo "usage -file '<filename>.docx]'"
+	--help | * ) 	echo "usage -file '<filename>.docx>'"
 					exit 1
 					;;
 esac