Skip to content

Commit

Permalink
Update support documentation. (#842)
Browse files Browse the repository at this point in the history
* Link to the signac discussion board.

* Point users to row.

* Fix link.
  • Loading branch information
joaander authored Jul 30, 2024
1 parent 8d6ab15 commit 035557a
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 4 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ The [**signac** framework](https://signac.io) helps users manage and scale file-
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).
That includes the definition of data pipelines, execution of data space operations and the submission of operations to high-performance super computers.

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

- [Framework documentation](https://docs.signac.io/):
Expand Down
5 changes: 5 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
signac-flow package documentation
=================================

.. tip::

Check out row_, the actively maintained spiritual successor to **signac-flow**.

.. note::

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

.. _row: https://row.readthedocs.io
.. _signac: https://signac.io/
.. _signac-docs: https://docs.signac.io/

Expand Down
6 changes: 3 additions & 3 deletions doc/support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Support and Development
Getting help and reporting issues
=================================

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]>`_.
Use the `signac discussion board <https://github.com/glotzerlab/signac/discussions/>`_ to
post questions, ask for support, and discuss potential new features.

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

Code contributions
==================
Expand Down
2 changes: 1 addition & 1 deletion doc/supported_environments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ In addition, the package provides specialized submission templates for the follo
supported_environments/umn

We develop environment templates and add scheduler support on an as-needed basis.
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.
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 comments on commit 035557a

Please sign in to comment.