Merge pull request #2 from openrepair/DAT-367-suggestions

Dat 367 suggestions

README.md

@@ -9,13 +9,16 @@ This repository contains the source files for building the technical documentati
 
 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". 
+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]: ` 
 
 Document tables should not contain merged cells.
 
-Embedded internal links to headings (e.g. See Appendix A) break PDF generation and should be omitted.
+Embedded internal links to headings only work within the same section as they are converted to anchors.
 
-Images should be embedded within a "normal text" paragraph.
+Images should be embedded within a "normal text" paragraph else they will appear as a heading.
 
 Image files can be exported by saving the (Google) document as "html", find them in the zipfile's images folder.
 
@@ -62,20 +65,3 @@ Full documentation at [Sphinx Documentation](https://www.sphinx-doc.org/en/maste
 
 [Documenting Your Project Using Sphinx](https://pythonhosted.org/an_example_pypi_project/sphinx.html)
 
-
-## PDF Exporter
-
-$ `pip install rst2pdf`
-
-$ `sphinx-build -b pdf ./ ./_pdf`
-
-[rst2pdf: Use a text editor. Make a PDF.](https://github.com/rst2pdf/rst2pdf)
-
-### Notes
-
-The generated file is not well formatted and ends up with the name of the first 
-rst file. See _pdf/about.pdf for result.
-
-Compare to _pdf/Open Repair Data Standard v0.2.pdf - Google Doc generated pdf.
-
-

_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 3b143769cbd2a6d481eca5170af00f1a
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_build/html/_sources/about.rst.txt

@@ -0,0 +1,22 @@
+
+About Open Repair Alliance
+=====================================
+
+Goals and ORDS use cases
+------------------------
+
+The initial objective of the Open Repair Alliance is to help
+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.
+
+Specifically, we aim to:
+
+-  Create a joint approach to documenting successes and challenges with post-warranty repairs
+
+-  Promote it as a standard available to other community repair networks, and in the future to commercial repairers and others collecting repair data
+
+-  Enable coalition members and others to use the data from our joint work to produce insights, with the objective of demanding more repairable products, improved support and access to better repair services
+
+-  Jointly explore additional information we can all collect to help make a stronger case for increased repairability

_build/html/_sources/document.rst.txt

@@ -0,0 +1,46 @@
+
+Document Information
+===============================
+
+Version
+-------
+
+*Number:* 0.2
+
+*Description*: Updated version agreed by Open Repair Alliance founding
+members, based on analysis and aggregation of data provided by partners
+
+*Published*: 21 12 2020
+
+*Authors:* The Restart Project
+
+License
+-------
+
+The Open Repair Data Standard and supporting documentation is licensed
+under the `*Creative Commons Attribution-ShareAlike 4.0 International
+(CC BY-SA 4.0* <https://creativecommons.org/licenses/by-sa/4.0/>`__).
+
+Changelog
+---------
+
+***V0.1*** - Initial version agreed by Open Repair Alliance founding
+members, published on 14 November 2017
+
+***V0.2*** - Published December 2020, including updates based on
+analysis and aggregation of data provided by partners
+
+-  Recommended options for *repair\_status*
+
+-  Recommended options for *product\_category* values
+
+-  Addition of *partner\_product\_category* field
+
+-  Addition of *repair\_barrier* field
+
+-  Addition of *country* field
+
+-  Removal of *model* field due to problems with data collection and quality
+
+-  Removal of “additional modules” section
+

_build/html/_sources/governance.rst.txt

@@ -0,0 +1,37 @@
+
+Governance and Membership
+====================================
+
+Founding members
+----------------
+
+Open Repair Alliance’s founding members are: Anstiftung Foundation,
+Fixit Clinic, iFixit, The Repair Cafe Foundation and The Restart
+Project.
+
+All founding members have a strong commitment to repair and to
+documenting the challenges and opportunities that we face. Most groups
+are non-profit organisations promoting community repair initiatives. The
+Alliance also contains a commercial organisation, iFixit, because of its
+commitment to sharing repair data as part of the Alliance and for its
+active role and strong voice campaigning for repairability in the United
+States and in Europe.
+
+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.
+
+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
+---------------
+
+Decisions on the standard are made through consensus between the core
+members.

_build/html/_sources/index.rst.txt

@@ -0,0 +1,17 @@
+
+Open Repair Data Standard
+=====================================
+
+This is the technical documentation of the Open Repair Data Standard.
+The standard is produced by the Open Repair Alliance.
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :name: mastertoc
+
+   Index <self>
+   about
+   governance
+   standard
+   document