Skip to content

Commit 035557a

Browse files
authored
Update support documentation. (#842)
* Link to the signac discussion board. * Point users to row. * Fix link.
1 parent 8d6ab15 commit 035557a

File tree

4 files changed

+11
-4
lines changed

4 files changed

+11
-4
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ The [**signac** framework](https://signac.io) helps users manage and scale file-
1515
The **signac-flow** tool provides the basic components to set up simple to complex workflows for projects managed by the [**signac** framework](https://signac.io).
1616
That includes the definition of data pipelines, execution of data space operations and the submission of operations to high-performance super computers.
1717

18+
> Note: Check out [row](https://row.readthedocs.io), the actively maintained spiritual successor to **signac-flow**.
19+
1820
## Resources
1921

2022
- [Framework documentation](https://docs.signac.io/):

doc/index.rst

+5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
signac-flow package documentation
22
=================================
33

4+
.. tip::
5+
6+
Check out row_, the actively maintained spiritual successor to **signac-flow**.
7+
48
.. note::
59

610
This is documentation for the **signac-flow** package, which is part of the signac_ framework.
711
See `here <signac-docs_>`_ for a comprehensive introduction to the **signac** *framework*.
812

13+
.. _row: https://row.readthedocs.io
914
.. _signac: https://signac.io/
1015
.. _signac-docs: https://docs.signac.io/
1116

doc/support.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Support and Development
77
Getting help and reporting issues
88
=================================
99

10-
To get help using the **signac-flow** package, join the `signac Slack workspace <https://signac.io/slack-invite/>`_ or send an email to `[email protected] <mailto:[email protected]>`_.
10+
Use the `signac discussion board <https://github.com/glotzerlab/signac/discussions/>`_ to
11+
post questions, ask for support, and discuss potential new features.
1112

12-
The **signac-flow** package is hosted on `GitHub <https://github.com/glotzerlab/signac-flow>`_ and licensed under the open-source BSD 3-Clause license.
13-
Please use the `repository's issue tracker <https://github.com/glotzerlab/signac-flow/issues>`_ to report bugs or request new features.
13+
File bug reports on `signac-flow's issue tracker <https://github.com/glotzerlab/signac-flow/issues>`_.
1414

1515
Code contributions
1616
==================

doc/supported_environments.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ In addition, the package provides specialized submission templates for the follo
3939
supported_environments/umn
4040

4141
We develop environment templates and add scheduler support on an as-needed basis.
42-
Please `contact us <mailto:[email protected]>`__ if you have trouble running **signac-flow** on your local cluster or need assistance with creating a template or supporting a new scheduler.
42+
Please `contact us <https://github.com/glotzerlab/signac/discussions>`__ if you have trouble running **signac-flow** on your local cluster or need assistance with creating a template or supporting a new scheduler.

0 commit comments

Comments
 (0)