datalad · adswa · Jul 16, 2020 · Jul 15, 2020 · Jul 15, 2020 · Jul 15, 2020
diff --git a/datalad_osf/create_sibling_osf.py b/datalad_osf/create_sibling_osf.py
@@ -56,7 +56,7 @@ class CreateSiblingOSF(Interface):
     node will - in opposition to the 'annex' - be
     human-readable.
 
-    For authentification with OSF, you can define environment variables: Either
+    For authentication with OSF, you can define environment variables: Either
     'OSF_TOKEN', or both 'OSF_USERNAME' and 'OSF_PASSWORD'. If neither of these
     is defined, the tool will fall back to the datalad credential manager and
     inquire for credentials interactively.

diff --git a/docs/source/_static/clueless.gif b/docs/source/_static/clueless.gif
diff --git a/docs/source/_static/datastore_sibling.png b/docs/source/_static/datastore_sibling.png
diff --git a/docs/source/_static/git-annex-osf-logo.png b/docs/source/_static/git-annex-osf-logo.png
diff --git a/docs/source/_static/public_annex_sibling.png b/docs/source/_static/public_annex_sibling.png
diff --git a/docs/source/_static/public_exportonly_sibling.png b/docs/source/_static/public_exportonly_sibling.png
diff --git a/docs/source/acknowledgements.rst b/docs/source/acknowledgements.rst
@@ -0,0 +1,23 @@
+Acknowledgments
+===============
+
+DataLad development is being performed as part of a US-German collaboration in
+computational neuroscience (CRCNS) project "DataGit: converging catalogues,
+warehouses, and deployment logistics into a federated 'data distribution'"
+(Halchenko_/Hanke_), co-funded by the US National Science Foundation (`NSF 1912266`_) and the German Federal Ministry of Education and Research (BMBF 01GQ1905).
+Additional support is provided by the German federal state of
+Saxony-Anhalt and the European Regional Development
+Fund (ERDF), Project: `Center for Behavioral Brain Sciences`_, Imaging Platform.
+
+DataLad is built atop the git-annex_ software that is being developed and
+maintained by `Joey Hess`_.
+
+The extension was created during the OHBM Hackathon 2020 and wouldn't have been possible without a `dedicated team of volunteers <https://github.com/datalad/datalad-osf#contributors->`_.
+
+.. _Halchenko: http://haxbylab.dartmouth.edu/ppl/yarik.html
+.. _Hanke: http://www.psychoinformatics.de
+.. _NSF 1912266: http://www.nsf.gov/awardsearch/showAward?AWD_ID=1912266
+.. _BMBF 01GQ1411: http://www.gesundheitsforschung-bmbf.de/de/2550.php
+.. _Center for Behavioral Brain Sciences: http://cbbs.eu/en/
+.. _git-annex: http://git-annex.branchable.com
+.. _Joey Hess: https://joeyh.name
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -0,0 +1,12 @@
+Python API
+==========
+
+``datalad-osf`` has two main commands that are exposed as functions via ``datalad.api`` and as methods of the ``Dataset`` class: ``osf_credentials`` for OSF authentication management, and ``create_sibling_osf`` for interactions with the OSF.
+Find out more about each command below.
+
+.. currentmodule:: datalad.api
+.. autosummary::
+   :toctree: generated
+
+   osf_credentials
+   create_sibling_osf
diff --git a/docs/source/cloneosfdata.rst b/docs/source/cloneosfdata.rst
diff --git a/docs/source/cmd.rst b/docs/source/cmd.rst
@@ -0,0 +1,13 @@
+.. _cmd:
+
+Command line reference
+======================
+
+``datalad-osf`` has two main commands: ``datalad osf-credentials`` for OSF authentication management, and ``datalad create-sibling-osf`` for interactions with the OSF.
+Find out more about each command below.
+
+.. toctree::
+   :maxdepth: 1
+
+   generated/man/datalad-create-sibling-osf
+   generated/man/datalad-osf-credentials
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -95,8 +95,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Datalad Extension Template'
-copyright = u'2018-{}, DataLad team'.format(datetime.datetime.now().year)
+project = u'Datalad-OSF'
+copyright = u'2020-{}, DataLad team'.format(datetime.datetime.now().year)
 author = u'DataLad team'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -0,0 +1,7 @@
+.. _contribute:
+
+Contributing
+============
+
+If you have any questions, comments, bug fixes or improvement suggestions, feel free to contact us via our `Github page <https://github.com/datalad/datalad-osf>`_.
+Before contributing, be sure to read the `contributing guidelines <https://github.com/datalad/datalad-osf/blob/master/CONTRIBUTING.md>`_.
diff --git a/docs/source/exportdatacode.rst b/docs/source/exportdatacode.rst
diff --git a/docs/source/exporthumandata.rst b/docs/source/exporthumandata.rst
diff --git a/docs/source/git-annex-utils.rst b/docs/source/git-annex-utils.rst
@@ -0,0 +1,13 @@
+.. include:: ./links.inc
+
+git-annex utilities
+===================
+
+``datalad-osf`` comes with a git-annex special remote implementation for the OSF.
+Find out more by clicking on the module name below.
+
+.. currentmodule:: datalad_osf
+.. autosummary::
+   :toctree: generated
+
+   annex_remote.OSFSpecialRemote
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,69 +1,39 @@
 .. include:: ./links.inc
 
-DataLad extension to interface with OSF
-***************************************
+DataLad-OSF: Opening up the Open Science Framework for DataLad
+--------------------------------------------------------------
 
-This extension enables DataLad_ to work with the Open Science Framework (OSF_).
-Use it to publish your dataset's data to an OSF project to utilize the OSF for dataset data storage and easy dataset sharing.
+This `DataLad extension <handbook.datalad.org/en/latest/r.html?extensions>`_ enables DataLad_ to work with the Open Science Framework (OSF_).
+Use it to publish your dataset's data to an OSF project to utilize the OSF for dataset data storage and share and collaborate on datasets.
 
-The extension was created during the OHBM Hackathon 2020.
+.. figure:: _static/git-annex-osf-logo.png
 
-If you have any questions, comments, bug fixes or improvement suggestions, feel free to contact us via our `Github page <https://github.com/datalad/datalad-osf>`_.
-Before contributing, be sure to read the `contributing guidelines <https://github.com/datalad/datalad-osf/blob/master/CONTRIBUTING.md>`_.
 
+The extension was created during the `OHBM Hackathon 2020 <https://ohbm.github.io/hackathon2020/>`_ and wouldn't have been possible without a `dedicated team of volunteers <https://github.com/datalad/datalad-osf#contributors->`_.
+If you want to get in touch or on board as well, please see our :ref:`contributing guidelines <contribute>`.
 
-.. toctree::
-
-Documentation
-=============
+Documentation overview
+^^^^^^^^^^^^^^^^^^^^^^
 
 .. toctree::
    :maxdepth: 2
 
    intro
    settingup
-   exporthumandata
-   exportdatacode
-   cloneosfdata
-
-
-API
-===
-
-High-level API commands
------------------------
-
-.. currentmodule:: datalad.api
-.. autosummary::
-   :toctree: generated
-
-   create_sibling_osf
-   osf_credentials
-
-
-Command line reference
-----------------------
+   tutorial
+   contributing
+   acknowledgements
 
 .. toctree::
    :maxdepth: 1
 
-   generated/man/datalad-create-sibling-osf
-   generated/man/datalad-osf-credentials
-
-
-
-Git-annex utilities
--------------------
-
-.. currentmodule:: datalad_osf
-.. autosummary::
-   :toctree: generated
-
-   annex_remote.OSFSpecialRemote
+   cmd
+   api
+   git-annex-utils
 
 
 Indices and tables
-==================
+^^^^^^^^^^^^^^^^^^
 
 * :ref:`genindex`
 * :ref:`modindex`