Michael Hanke
6b206b0367
This acts on the report by `tool/link_consolidator.py`. This changeset is large but conceptually simple: - no http:// links anymore, unless there is no https:// alternative - no redundant trailing slashes - no redundant "latest" flavors in doc links - resolve permanent redirects - if there is a simpler/shorter URL that points to the same information, go for that one - reduce duplicate specifications of URLs in a single file With all changes applied, the link consolidator still reports the following issues: - `docs/glossary.rst`: - *line 163*: `permanent-redirect` [https://try.github.io - permanently to https://docs.github.com/en/get-started/quickstart/set-up-git] - `docs/basics/101-127-yoda.rst`: - *line 453*: `permanent-redirect` [https://the-turing-way.netlify.app - permanently to https://the-turing-way.netlify.app/index.html] - `docs/basics/101-180-FAQ.rst`: - *line 128*: `none-https` [http://www.humanconnectomeproject.org] - `docs/beyond_basics/101-173-contributing.rst`: - *line 34*: `none-https` [http://source.git-annex.branchable.com/?p=source.git;a=summary] - `docs/usecases/HCP_dataset.rst`: - *line 63*: `none-https` [http://www.humanconnectomeproject.org/wp-content/uploads/2010/01/HCP_Data_Agreement.pdf] The non-https URLs have no alternative. The perma-redirects make the URLs needlessly long. So I decided to keep them.
13 lines
735 B
ReStructuredText
13 lines
735 B
ReStructuredText
.. _design:
|
|
|
|
DataLad's internal design
|
|
-------------------------
|
|
|
|
|
|
.. figure:: ../artwork/src/design.svg
|
|
:width: 50%
|
|
|
|
The handbook should have provided plenty of insights into common usage patterns for DataLad.
|
|
When approaching the software not from a user perspective, but from a developer angle, you can find further information on the design principles and internal code structure in DataLad's Design Documents.
|
|
These documents are part of the developer docs at `docs.datalad.org <https://docs.datalad.org>`_ and constitute an ongoing effort to document and harmonize the development rules and processes.
|
|
Head over to `docs.datalad.org/design/index.html <https://docs.datalad.org/en/stable/design/index.html>`_ to find out more.
|