Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding some illustrations #329

Merged
merged 3 commits into from
Dec 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/basics/101-108-run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ a file with its origin and store this information, we want to be
able to associate a particular file with the commands, scripts, and inputs
it was produced from, and thus capture and store full :term:`provenance`.

.. figure:: ../artwork/src/keeptrack.svg
:width: 70%

Let's say, for example, that you enjoyed the longnow podcasts a lot,
and you start a podcast-night with friends to wind down from all of
the exciting DataLad lectures. They propose to make a
Expand Down
3 changes: 3 additions & 0 deletions docs/basics/101-114-txt2git.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ the first student in your lecturer's office hours.
"Oh, you're really attentive. This is a great question!" our lecturer starts
to explain.

.. figure:: ../artwork/src/teacher.svg
:width: 70%

Do you remember that we created the ``DataLad-101`` dataset with a
specific configuration template? It was the ``-c text2git`` option we
provided in the beginning of :ref:`createDS`. It is because of this configuration
Expand Down
4 changes: 4 additions & 0 deletions docs/basics/101-116-sharelocal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ help facilitate collaboration without requiring ultimate trust and
reliability of all participants. Essentially, with a shared dataset,
collaborators can look and use your dataset without ever touching it.


.. figure:: ../artwork/src/collaboration_sketch.svg
:width: 70%

To demonstrate how to share a DataLad dataset on a common file system,
we will pretend that your personal computer
can be accessed by other users. Let's say that
Expand Down
4 changes: 4 additions & 0 deletions docs/basics/101-130-yodaproject.rst
Original file line number Diff line number Diff line change
Expand Up @@ -742,6 +742,10 @@ reproduce your data science project easily from scratch!
Proud of your midterm project you can not wait to use those principles the
next time again.

.. figure:: ../artwork/src/reproduced.svg
:width: 50%


.. rubric:: Footnotes

.. [#f1] Note that you could have applied the YODA procedure not only right at
Expand Down
3 changes: 3 additions & 0 deletions docs/basics/101-135-help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ outside of this course?
Fortunately, the syllabus has a whole section on that, and on
one lazy, warm summer-afternoon you flip through it.

.. figure:: ../artwork/src/reading.svg
:width: 50%

You realize that you already know the most important things:
The number one advice on how to get help is
`"Read the error message." <http://poster.keepcalmandposters.com/default/5986752_keep_calm_and_read_the_error_message.png>`_.
Expand Down
3 changes: 3 additions & 0 deletions docs/basics/101-137-history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ it is possible to look at previous states of the data, or revert changes --
even years after they happened -- thanks to the underlying version control
system :term:`Git`.

.. figure:: ../artwork/src/versioncontrol.svg
:width: 70%

To get a glimpse into how to work with the history of a dataset, today's lecture
has an external Git-expert as a guest lecturer.
"I do not have enough time to go through all the details in only
Expand Down
3 changes: 3 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ To find out how we acknowledge contributions, please read the paragraph
:ref:`acknowledge` at the bottom of
this page.

.. figure:: artwork/src/contributing.svg
:width: 50%

If you are considering doing a pull request: Great! Every contribution is valuable,
from fixing typos to writing full chapters.
The steps below outline how the book "works". It is recommended to also create an issue
Expand Down
7 changes: 7 additions & 0 deletions docs/intro/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ DataLad tool, many
`extensions <http://docs.datalad.org/en/latest/index.html#extension-packages>`_
exist, and they need to be installed separately, if needed.

.. figure:: ../artwork/src/install.svg
:width: 70%


Linux: (Neuro)Debian, Ubuntu, and similar systems
"""""""""""""""""""""""""""""""""""""""""""""""""
Expand Down Expand Up @@ -487,6 +490,10 @@ Initial configuration

Initial configurations only concern the setup of a :term:`Git` identity. If you
are a Git-user, you should hence be good to go.

.. figure:: ../artwork/src/gitidentity.svg
:width: 70%

If you have not used the version control system Git before, you will need to
tell Git some information about you. This needs to be done only once.
In the following example, exchange ``Bob McBobFace`` with your own name, and
Expand Down
3 changes: 3 additions & 0 deletions docs/intro/narrative.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,9 @@ populating them by ``installing`` and ``creating`` several
and executing simple scripts with input data to create results we can
share and publish with DataLad.

.. figure:: ../artwork/src/student.svg
:width: 70%

If you do not want to follow along and only read, there will be a
finished DataLad-101 project for you to download and explore in the future.
The dataset will contain tags that relate different states of it to the
Expand Down