[SHARE-377][Improvement] Update read the docs (#618)

* Update SHARE type link

* Update links and wording

* Remove troubleshooting page because it had no useful information

* Update @type section

* Remove sharepa links and add support email

Author: laurenbarker

docs/elasticsearch.rst

@@ -128,28 +128,3 @@ _source → lists → contributors → (contributor) → identifiers ::
 
 Search for an ORCID identifier:
 https://share.osf.io/api/v2/search/creativeworks/_search?q=lists.contributors.identifiers:”XXXX-XXXX-XXXX-XXXX”
-
-
-Tutorials
-*********
-
-For a detailed series of tutorials on how to use the SHARE Search API, check out `this repository on GitHub  <https://github.com/erinspace/share_tutorials>`_.
-
-Run these tutorials online here: http://mybinder.org:/repo/erinspace/share_tutorials
-
-
-sharepa - SHARE Parsing and Analysis Library
-********************************************
-
-You can also use ``sharepa`` - a python library for parsing SHARE data that connects directly to the search API. It is based on the
-`elasticsearch DSL  <http://elasticsearch-dsl.readthedocs.io/en/latest/index.html>`_.
-
-You can see the `source code for sharepa on GitHub  <https://github.com/CenterForOpenScience/sharepa>`_.
-
-Install the beta version of sharepa with::
-
-    pip install git+https://github.com/CenterForOpenScience/sharepa@develop
-
-See some tutorials on how to use sharepa by visiting `this repository on GitHub  <https://github.com/erinspace/share_tutorials>`_.
-
-Run the tutorials Online without installing anything by visiting http://mybinder.org:/repo/erinspace/share_tutorials

docs/index.rst

@@ -10,18 +10,17 @@ SHARE harvests metadata nightly from 100+ repositories, transforms that metadata
 
 The technical side of SHARE has many pieces that you can interact with:
 
-- API Endpoints for accessing the raw and transformed metadata
-    + https://share.osf.io/api
 - A search endpoint powered by elasticsearch that indexes the transformed data allowing:
    - Thorough search of creative works:
         + Creative works: `</api/v2/search/creativeworks/_search_>`_
         + more info on the `elasticsearch docs`_ page
    - Data aggregations across fields
-- A python library called ``sharepa`` for SHARE Parsing and Analysis
 - An `Ember application`_ using the SHARE API for:
+   - Searching the SHARE database
    - Discovering new Projects
-   - Curation
    - Corrections and Updates
+- API Endpoints for accessing transformed metadata
+    + https://share.osf.io/api/v2
 
 .. _`/api/v2/search/creativeworks/_search`: https://share.osf.io/api/v2/search/creativeworks/_search
 .. _Ember application: /page/ember_app.html
@@ -39,7 +38,6 @@ Guide
     elasticsearch
     share_api
     ember_app
-    troubleshooting
 
 Contribute
 ==========
@@ -50,6 +48,8 @@ Contribute
 Get In Touch
 ============
 
+For emails about technical support: share-support@osf.io
+
 ::
 
    Association of Research Libraries

docs/quickstart.rst

@@ -52,18 +52,6 @@ Run a harvester::
 
     python manage.py harvest domain.providername --async
 
-To see a list of all providers, as well as their names for harvesting, visit https://share.osf.io/api/providers/
+To see a list of all providers, as well as their names for harvesting, visit https://share.osf.io/api/v2/sources
 
 For more information, see the section on :ref:`Harvesters and Transformers <harvesters-and-transformers>`.
-
-
-sharepa
-^^^^^^^
-sharepa is the SHARE Parsing and Analysis Library. It is a python library that you can install to directly access SHARE's
-elasticsearch API, and use to quickly generate summary statistics covering the metadata in SHARE.
-
-You can find the `source code for sharepa on GitHub <https://github.com/CenterForOpenScience/sharepa>`_.
-
-Install sharepa by running::
-
-    pip install sharepa

docs/share_api.rst

@@ -56,25 +56,37 @@ A change is represented as a JSON object with a single key, ``@graph``, containi
 
 - ``@type`` MUST be a `SHARE type`_.
 
-    .. note:: ``@type`` is case insensitive.
+    .. note:: ``@type`` is case sensitive and expects title case, lowercase, or uppercase types.
 
     .. code-block:: javascript
 
-        // GOOD: A Type from the linked page
+        // GOOD: Title case for a type from the linked page
         {
             "@type": "Preprint"
             // Omitted...
         }
 
-        // GOOD: Another type from the linked page
+        // GOOD: All lowercase for a type from the linked page
         {
-            "@id": "cReAtIvEwOrK"
+            "@type": "article"
+            // Omitted...
+        }
+
+        // GOOD: All uppercase for a type from the linked page
+        {
+            "@type": "CREATIVEWORK"
+            // Omitted...
+        }
+
+        // BAD: Other casing of a type from the linked page
+        {
+            "@type": "cReAtIvEwOrK"
             // Omitted...
         }
 
         // BAD: Anything else
         {
-            "@id": "Unicorn"
+            "@type": "Unicorn"
             // Omitted...
         }
 
@@ -555,6 +567,8 @@ Code Examples
 
 .. _normalizeddata endpoint: https://share.osf.io/api/normalizeddata
 
+.. _SHARE type: https://share.osf.io/api/v2/schema
+
 .. _SHARE website: https://share.osf.io
 
 .. _OAuth2: http://self-issued.info/docs/draft-ietf-oauth-v2-bearer.html