From f8744b30c4416ab4f878f09242532c7055ff8854 Mon Sep 17 00:00:00 2001 From: Taylor Salo Date: Thu, 1 Nov 2018 08:25:08 -0400 Subject: [PATCH 1/3] Add Support and Communication page to docs. --- docs/contributing.rst | 20 ++++++++++++++++++-- docs/index.rst | 3 ++- docs/installation.rst | 16 ---------------- docs/support.rst | 10 ++++++++++ 4 files changed, 30 insertions(+), 19 deletions(-) create mode 100644 docs/support.rst diff --git a/docs/contributing.rst b/docs/contributing.rst index caf9399f6..12a16201a 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,3 +1,19 @@ +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 + Contributing to tedana ====================== @@ -11,7 +27,7 @@ For a more general guide to the tedana development, please see our Style Guide ------------ +=========== Code ```` @@ -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 diff --git a/docs/index.rst b/docs/index.rst index 326178cfe..c523af10c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/installation.rst b/docs/installation.rst index 82fc724a0..7645b9859 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -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 diff --git a/docs/support.rst b/docs/support.rst new file mode 100644 index 000000000..b2343d622 --- /dev/null +++ b/docs/support.rst @@ -0,0 +1,10 @@ +Support and Communication +------------------------- +All bugs, concerns and enhancement requests for this software can be submitted here: https://github.com/poldracklab/fmriprep/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 From 4ad04424ee5645e584fe90f9b72e3a4c5bdb7573 Mon Sep 17 00:00:00 2001 From: Taylor Salo Date: Thu, 1 Nov 2018 13:57:32 -0400 Subject: [PATCH 2/3] Fix old link. --- docs/support.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/support.rst b/docs/support.rst index b2343d622..0828ea5c8 100644 --- a/docs/support.rst +++ b/docs/support.rst @@ -1,6 +1,6 @@ Support and Communication ------------------------- -All bugs, concerns and enhancement requests for this software can be submitted here: https://github.com/poldracklab/fmriprep/issues. +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. From 73cf8c82e81461401b2749f15aaade02dc56ae28 Mon Sep 17 00:00:00 2001 From: Elizabeth DuPre Date: Thu, 1 Nov 2018 14:34:14 -0400 Subject: [PATCH 3/3] [DOC] Remove getting started section --- docs/contributing.rst | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 12a16201a..42bfc6acc 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,19 +1,3 @@ -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 - Contributing to tedana ======================