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

Collect contact information on single page #847

Merged
merged 1 commit into from
Apr 4, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 5 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,14 @@ they have been modified.
Support
-------

You can communicate with the :term:`FiPy` developers and with other
users via our `mailing list`_ and we welcome you to use the `issue
tracker`_ for bugs, support requests, feature requests and patch
submissions <https://github.com/usnistgov/fipy/issues>. We also monitor
StackOverflow_ for questions tagged with "fipy". We welcome
collaborative efforts on this project.
We offer several modes to communicate with the :term:`FiPy` developers and
with other users.

.. toctree::

documentation/MAIL
documentation/CONTACT

We welcome collaborative efforts on this project.

------------------------
Conventions and Notation
Expand Down Expand Up @@ -151,9 +149,6 @@ or a
.. _CTCMS: http://www.ctcms.nist.gov/
.. _MSED: http://www.nist.gov/mml/msed/
.. _NIST: http://www.nist.gov/
.. _issue tracker: https://github.com/usnistgov/fipy/issues
.. _mailing list: http://www.ctcms.nist.gov/fipy/documentation/MAIL.html
.. _StackOverflow: http://stackoverflow.com/questions/tagged/fipy

.. |GitHub| image:: https://img.shields.io/github/contributors/usnistgov/fipy.svg
.. _GitHub: https://github.com/usnistgov/fipy
Expand Down
88 changes: 88 additions & 0 deletions documentation/CONTACT.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
-------
Contact
-------

In order to discuss :term:`FiPy` with other users and with the developers,
we encourage you to use one of the following modes of communication. We
monitor all of these, so there is no need to post to more than one of them.

You may want to read the following resource about asking
effective questions: http://www.catb.org/~esr/faqs/smart-questions.html

If you are having trouble, we are able to offer much more effective help if
you provide a `minimal reproducible example
<https://stackoverflow.com/help/minimal-reproducible-example>`__.

.. _DISCUSSIONS:

GitHub Discussions
==================

https://github.com/usnistgov/fipy/discussions

Suitable for open-ended conversations, troubleshooting, showing off…

If a discussion highlights a bug or feature request, it’s easy for us to
migrate :ref:`DISCUSSIONS` to :ref:`ISSUES`.

.. _ISSUES:

GitHub Issues
=============

https://github.com/usnistgov/fipy/issues

Suitable for bug reports, feature requests, and patch submissions.

StackOverflow
=============

https://stackoverflow.com/questions/tagged/fipy

Suitable for questions that (probably) have definitive answers ("How do
I...?"). It doesn’t work so well for back-and-forth conversations, which
are better suited to :ref:`DISCUSSIONS`.

Mailing List
============

.. attention::

The mailing list is deprecated. Please use :ref:`DISCUSSIONS`, instead.

You can sign up for the mailing list by sending a `subscription
email <mailto:fipy+subscribe@list.nist.gov>`__ to
<mailto:fipy+subscribe@list.nist.gov>.

Once you are subscribed, you can post messages to the list simply by
addressing email to <mailto:fipy@list.nist.gov>.

To get off the list, send a message to
<mailto:fipy+unsubscribe@list.nist.gov>.

Send a message to <mailto:fipy+help@list.nist.gov> to learn other mailing
list configurations you can change.

The list is hosted as a Google group. If you are subscribed with a Google
account, you can interact with the list, configure your subscription, and
see the archives at https://list.nist.gov/fipy.

List Archive
------------

https://www.mail-archive.com/fipy@list.nist.gov/

Copies of messages sent to fipy@list.nist.gov are stored at `The Mail Archive`_.

Older messages are archived at https://www.mail-archive.com/fipy@nist.gov/.

(note: we have also historically sent copies to
http://dir.gmane.org/gmane.comp.python.fipy, but the GMANE_ site now
appears to be defunct_.)


.. _The Mail Archive: https://www.mail-archive.com

.. _GMANE: http://gmane.org/

.. _defunct: https://lars.ingebrigtsen.no/2016/07/28/the-end-of-gmane/
45 changes: 0 additions & 45 deletions documentation/MAIL.rst

This file was deleted.

18 changes: 3 additions & 15 deletions documentation/_themes/nist/contact.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,21 +71,9 @@ <h2 class="nist-block__title">NIST Staff</h2>
<div data-layout-content-preview-placeholder-label="&quot;Contact&quot; field"
class="nist-block nist-block--contact nist-block--mail">

<h2 class="nist-block__title">Contact</h2>

<div class="nist-field nist-field--label-hidden
nist-field--link-list entity-reference nist-field__items
nist-field--no-margin">
<p>
Join our
<a class="" href="{{ pathto('documentation/MAIL') }}" style="">mailing list</a>,
open an issue at the
<a href="/cgi-bin/redirect.py?url=https://github.com/usnistgov/fipy/issues">tracker</a>,
or ask a question on
<a href="/cgi-bin/redirect.py?url=https://stackoverflow.com/questions/tagged/fipy">StackOverflow</a>.
</p>
</div>

<h2 class="nist-block__title">
<a class="" href="{{ pathto('documentation/CONTACT') }}" style="">Contact</a>
</h2>

</div>

Expand Down