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.
36 lines
5 KiB
ReStructuredText
36 lines
5 KiB
ReStructuredText
.. _contributing_datalad:
|
|
|
|
Contributing to DataLad
|
|
-----------------------
|
|
|
|
|
|
DataLad is free and open source software.
|
|
Everyone can contribute in various forms -- feature requests, questions, artwork, tutorials, code patches, bug reports, ... even follows, likes, or retweets on `Twitter <https://twitter.com/datalad>`_, boosts on `Mastodon <https://fosstodon.org/@datalad>`_, or discussions in our `matrix chatroom <https://app.element.io/#/room/%23datalad:matrix.org>`_.
|
|
We would be delighted to hear from you in any form.
|
|
|
|
.. figure:: ../artwork/src/join.svg
|
|
:width: 50%
|
|
|
|
The following resources could be helpful:
|
|
|
|
For the Handbook
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
* Take a look at the section :ref:`contribute` for more information.
|
|
|
|
For DataLad
|
|
^^^^^^^^^^^
|
|
|
|
* **Use it!** Although it may sound nothing like a contribution, *using* DataLad is a fundamental contribution anyone can make. You can find further tutorials, materials, videos, and other resources in this handbook, and in a dedicated `Tutorials repository <https://github.com/datalad/tutorials>`_. And if you like it, you can also tell your friends, system administrators, and colleagues about it, or convince your local IT department to install it on shared compute infrastructure.
|
|
|
|
* **Get in touch**: We strive to improve the clarity of DataLad and its documentation. If you tried to implement DataLad in a specific way and the existing documentation didn't make sense, or wasn't clear enough or even confusing, please help us fix it. Let us know that the instructions could have been clearer, or that it didn't cover your use case, or led you along the wrong path. And if you have suggestions for improvements, let's incorporate them! Come chat with us about what you do on `Matrix <https://app.element.io/#/room/%23datalad:matrix.org>`_ (a free, decentralized, and secure communication network), tag ``datalad`` in an issue on `Neurostars <https://neurostars.org>`_, or get in touch via :term:`GitHub`.
|
|
|
|
* **Show your support**: If you like DataLad you can show your support in various meaningful ways. You can `"star" <https://github.com/datalad/datalad/stargazers>`_ the project on GitHub. You can subscribe, like, or follow DataLad on social media: There is a `Twitter Account <https://twitter.com/datalad>`_ and a `Mastodon Account <https://fosstodon.org/@datalad>`_ on which we regularly post updates, and a `YouTube channel <https://youtube.com/datalad>`_ on which we post tutorials and talks. And if you write academic papers or blog posts, you can cite the `paper about DataLad <https://joss.theoj.org/papers/10.21105/joss.03262>`_ if DataLad assisted in your work.
|
|
|
|
* **Contribute on GitHub**: A most valuable contribution is your time. We are interested and grateful for opinions, bug reports, feature requests, patches, larger code contributions, or simply a notice what you use DataLad for. Find the relevant repository, be that `github.com/datalad/datalad <https://github.com/datalad/datalad>`_ (the main repository), `github.com/datalad-datasets <https://github.com/datalad-datasets>`_ (many open datasets), or any :term:`DataLad extension`, and open issues or pull requests. DataLad's `CONTRIBUTING <https://github.com/datalad/datalad/blob/master/CONTRIBUTING.md>`_ file has tons of technical and social information to get you started with code contributions. But don't be intimidated by the wealth of information you will find in there. We'll be happy to help you at any stage. Also, you can take a look at technical docs (`docs.datalad.org <https://docs.datalad.org>`_) and in particular the :ref:`Design documents <design>` that shed light on the internal design principles of the software.
|
|
|
|
* **Write an extension!** If you have unique use cases, you can write your own :term:`DataLad extension` for it, that can provide any number of additional DataLad commands that are automatically included in DataLad's command line and Python API. Our `extension template <https://github.com/datalad/datalad-extension-template>`_ is the best starting point. It contains an example command implementation, and will have test setup and packaging configurations in place already. If you want to, you can register your extension against DataLad's extension registry at `github.com/datalad/datalad-extensions <https://github.com/datalad/datalad-extensions>`_ -- if your project is included, we can continuously check whether current versions of DataLad work with your extension.
|
|
|
|
* **Contribute to related projects** As open source software, we proudly stand on the shoulders of giants. The DataLad project wouldn't be possible without many other open source packages and projects. Helping them helps us, and you could do so in any of the ways described above, including documentation, tutorials, patches, support -- if you have a passion for `Haskell <https://www.haskell.org>`_ or `C <https://en.wikipedia.org/wiki/C_(programming_language)>`_ you could even head over to `git-annex <http://source.git-annex.branchable.com/?p=source.git;a=summary>`_ or `Git <https://github.com/git/git>`_ themselves.
|
|
|
|
Thank you for your interest and support!
|