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.

Sign up for GitHub

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

[DOC] Add Support page #150

Merged
merged 6 commits into from
Nov 1, 2018
Merged

[DOC] Add Support page #150

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
848d1f9
Merge remote-tracking branch 'ME-ICA/master'
tsalo Sep 20, 2018
5577fcc
Merge remote-tracking branch 'ME-ICA/master'
tsalo Nov 1, 2018
f8744b3
Add Support and Communication page to docs.
tsalo Nov 1, 2018
d1ba112
Merge remote-tracking branch 'ME-ICA/master' into support
tsalo Nov 1, 2018
4ad0442
Fix old link.
tsalo Nov 1, 2018
73cf8c8
[DOC] Remove getting started section
emdupre Nov 1, 2018
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
20 changes: 18 additions & 2 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
Getting involved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you pull this out ? It's a good reminder for me, though, to update index.rst...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussed with @tsalo offline and removed this

----------------

We 💛 new contributors!
To get started, check out `our contributing guidelines`_.

Want to learn more about our plans for developing ``tedana``?
Have a question, comment, or suggestion?
Open or comment on one of `our issues`_!

We ask that all contributions to ``tedana`` respect our `code of conduct`_.

.. _our contributing guidelines: https://github.com/ME-ICA/tedana/blob/master/CONTRIBUTING.md
.. _our issues: https://github.com/ME-ICA/tedana/issues
.. _code of conduct: https://github.com/ME-ICA/tedana/blob/master/CODE_OF_CONDUCT.md

Contributing to tedana
======================

Expand All @@ -11,7 +27,7 @@ For a more general guide to the tedana development, please see our


Style Guide
-----------
===========

Code
````
Expand Down Expand Up @@ -44,7 +60,7 @@ This tells the development team that your pull request is a "work-in-progress",
and that you plan to continue working on it.

Release Checklist
-----------------
=================

This is the checklist of items that must be completed when cutting a new release of tedana.
These steps can only be completed by a project maintainer, but they are a good resource for
Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,12 @@ tedana is licensed under GNU Lesser General Public License version 2.1.
:maxdepth: 2
:caption: Contents:

installation
multi-echo
usage
installation
approach
outputs
support
contributing
api

Expand Down
16 changes: 0 additions & 16 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,3 @@ You can then install ``tedana`` with:
.. code-block:: bash

pip install tedana

Getting involved
----------------

We 💛 new contributors!
To get started, check out `our contributing guidelines`_.

Want to learn more about our plans for developing ``tedana``?
Have a question, comment, or suggestion?
Open or comment on one of `our issues`_!

We ask that all contributions to ``tedana`` respect our `code of conduct`_.

.. _our contributing guidelines: https://github.com/ME-ICA/tedana/blob/master/CONTRIBUTING.md
.. _our issues: https://github.com/ME-ICA/tedana/issues
.. _code of conduct: https://github.com/ME-ICA/tedana/blob/master/CODE_OF_CONDUCT.md
10 changes: 10 additions & 0 deletions docs/support.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Support and Communication
-------------------------
All bugs, concerns and enhancement requests for this software can be submitted here: https://github.com/ME-ICA/tedana/issues.

If you would like to ask a question about usage or tedana's outputs, please submit a question to `NeuroStars`_ with the ``multi-echo`` tag.

All previous tedana-related questions are available `here`_.

.. _NeuroStars: https://neurostars.org
.. _here: https://neurostars.org/tags/multi-echo