From cb130cdd7729d7d1fc007d16b17efabda9690319 Mon Sep 17 00:00:00 2001 From: "Joshua A. Anderson" Date: Fri, 31 Jan 2025 16:16:39 -0500 Subject: [PATCH] Update signac links. --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 8 ++++---- README.md | 17 ++++++----------- doc/conf.py | 6 +++--- doc/index.rst | 6 +++--- doc/installation.rst | 2 +- pyproject.toml | 4 ++-- signac_dashboard/dashboard.py | 2 +- signac_dashboard/templates/layout.html | 6 +++--- signac_dashboard/templates/login.html | 2 +- 11 files changed, 26 insertions(+), 31 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a036612f..c806a672 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,5 +15,5 @@ - [ ] I am familiar with the [Contributing Guidelines](https://github.com/glotzerlab/signac-dashboard/blob/main/CONTRIBUTING.md). - [ ] I agree with the terms of the [Contributor Agreement](https://github.com/glotzerlab/signac-dashboard/blob/main/ContributorAgreement.md). - [ ] The changes introduced by this pull request are covered by existing or newly introduced tests. -- [ ] The [package documentation](https://github.com/glotzerlab/signac-dashboard/tree/main/doc) and [framework documentation](https://docs.signac.io/) in [signac-docs](https://github.com/glotzerlab/signac-docs) are up to date with these changes. +- [ ] The [package documentation](https://github.com/glotzerlab/signac-dashboard/tree/main/doc) and [framework documentation](https://signac.readthedocs.io/) in [signac-docs](https://github.com/glotzerlab/signac-docs) are up to date with these changes. - [ ] I have updated the [changelog](https://github.com/glotzerlab/signac-dashboard/blob/main/changelog.txt) and added any related issue and pull request numbers for future reference. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index dab941ab..2d262946 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,5 +1,5 @@ # Code of Conduct The signac team is committed to fostering a diverse and welcoming community. -The signac project has therefore adopted the [Contributor Covenant Code of Conduct](https://signac.io/conduct/). +The signac project has therefore adopted the [Contributor Covenant Code of Conduct](https://github.com/glotzerlab/signac/blob/main/conduct.md). Please email [signac-support@umich.edu](mailto:signac-support@umich.edu) if you have any questions or concerns. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80889493..9a09bd71 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,8 +7,8 @@ Please use the [GitHub issue tracker](https://github.com/glotzerlab/signac/issue ## Writing Documentation -A general introduction in the form of tutorials, guides, and recipes is published as part of the framework documentation at [https://docs.signac.io](https://docs.signac.io). -The API of each package as part of the framework is documented in the form of doc-strings, which are published on `https://docs.signac.io/projects/$package`, where `$package` is currently one of `core`, `flow`, or `dashboard`. +A general introduction in the form of tutorials, guides, and recipes is published as part of the framework documentation at [https://signac.readthedocs.io/](https://signac.readthedocs.io/). +The API of each package as part of the framework is documented in the form of doc-strings, which are published on `https://signac.readthedocs.io/projects/$package`, where `$package` is currently one of `core`, `flow`, or `dashboard`. Anyone is invited to add to or edit any part of the documentation. To fix a spelling mistake or make minor edits, click on the **Edit on GitHub** button in the top-right corner. @@ -34,10 +34,10 @@ All contributors must agree to the Contributor Agreement ([ContributorAgreement. * Create [unit tests](https://en.wikipedia.org/wiki/Unit_testing) and [integration tests](https://en.wikipedia.org/wiki/Integration_testing) that cover the common cases and the corner cases of the code. * Preserve backwards-compatibility whenever possible, and make clear if something must change. * Document any portions of the code that might be less clear to others, especially to new developers. -* Write API documentation in this package, and put usage information, guides, and concept overviews in the [framework documentation](https://docs.signac.io/) ([source](https://github.com/glotzerlab/signac-docs/)). +* Write API documentation in this package, and put usage information, guides, and concept overviews in the [framework documentation](https://signac.readthedocs.io/) ([source](https://github.com/glotzerlab/signac-docs/)). * Use inclusive language in all documentation and code. The [Google developer documentation style guide](https://developers.google.com/style/inclusive-documentation) is a helpful reference. -Please see the [Support](https://docs.signac.io/projects/core/en/latest/support.html) section as part of the documentation for detailed development guidelines. +Please see the [Support](https://signac.readthedocs.io/projects/core/en/latest/support.html) section as part of the documentation for detailed development guidelines. ### Code Style diff --git a/README.md b/README.md index aec0d44c..73f17ea8 100644 --- a/README.md +++ b/README.md @@ -3,31 +3,26 @@ [![Affiliated with NumFOCUS](https://img.shields.io/badge/NumFOCUS-affiliated%20project-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org/sponsored-projects/affiliated-projects) [![PyPI](https://img.shields.io/pypi/v/signac-dashboard.svg)](https://pypi.org/project/signac-dashboard/) [![conda-forge](https://img.shields.io/conda/vn/conda-forge/signac-dashboard.svg?style=flat)](https://anaconda.org/conda-forge/signac-dashboard) -[![RTD](https://img.shields.io/readthedocs/signac-dashboard.svg?style=flat)](https://docs.signac.io) +[![RTD](https://img.shields.io/readthedocs/signac-dashboard.svg?style=flat)](https://signac.readthedocs.io/) [![License](https://img.shields.io/github/license/glotzerlab/signac-dashboard.svg)](https://github.com/glotzerlab/signac-dashboard/blob/main/LICENSE.txt) [![PyPI-downloads](https://img.shields.io/pypi/dm/signac-dashboard.svg?style=flat)](https://pypistats.org/packages/signac-dashboard) -[![Slack](https://img.shields.io/badge/Slack-chat%20support-brightgreen.svg?style=flat&logo=slack)](https://signac.io/slack-invite/) [![Twitter](https://img.shields.io/twitter/follow/signacdata?style=social)](https://twitter.com/signacdata) [![GitHub Stars](https://img.shields.io/github/stars/glotzerlab/signac-dashboard?style=social)](https://github.com/glotzerlab/signac-dashboard/) -The [**signac** framework](https://signac.io) helps users manage and scale file-based workflows, facilitating data reuse, sharing, and reproducibility. +The [**signac** framework](https://signac.readthedocs.io) helps users manage and scale file-based workflows, facilitating data reuse, sharing, and reproducibility. The **signac-dashboard** package allows users to rapidly visualize and analyze data from a **signac** project in a web browser. ## Resources -- [Dashboard topic guide](https://docs.signac.io/en/latest/dashboard.html): +- [Dashboard topic guide](https://signac.readthedocs.io/en/latest/dashboard.html): Introduction to **signac-dashboard**. -- [Dashboard documentation](https://docs.signac.io/projects/dashboard/): +- [Dashboard documentation](https://signac.readthedocs.io/projects/dashboard/): Package reference and APIs. - [Dashboard examples](examples/): Example dashboards demonstrating a variety of use cases. -- [Framework documentation](https://docs.signac.io/): +- [Framework documentation](https://signac.readthedocs.io/): Examples, tutorials, topic guides, and package Python APIs. -- [Slack Chat Support](https://signac.io/slack-invite/): - Get help and ask questions on the **signac** Slack workspace. -- [**signac** website](https://signac.io/): - Framework overview and news. ## Installation @@ -46,7 +41,7 @@ To install **signac-dashboard** *via* **pip**, execute: pip install signac-dashboard ``` -**Detailed information about alternative installation methods can be found in the [documentation](https://docs.signac.io/projects/dashboard/en/latest/installation.html).** +**Detailed information about alternative installation methods can be found in the [documentation](https://signac.readthedocs.io/projects/dashboard/en/latest/installation.html).** ## Quickstart diff --git a/doc/conf.py b/doc/conf.py index 98e78208..0029ba2a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -191,9 +191,9 @@ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { "python": ("https://docs.python.org/3/", None), - "signac-docs": ("https://docs.signac.io/en/latest/", None), - "signac": ("https://docs.signac.io/projects/core/en/latest/", None), - "flow": ("https://docs.signac.io/projects/flow/en/latest/", None), + "signac-docs": ("https://signac.readthedocs.io/en/latest/", None), + "signac": ("https://signac.readthedocs.io/projects/core/en/latest/", None), + "flow": ("https://signac.readthedocs.io/projects/flow/en/latest/", None), "flask": ("https://flask.palletsprojects.com/", None), "werkzeug": ("https://werkzeug.palletsprojects.com/", None), } diff --git a/doc/index.rst b/doc/index.rst index fd82882e..7801c067 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,8 +6,8 @@ signac-dashboard package documentation This is documentation for the **signac-dashboard** package, which is part of the signac_ framework. See `here `_ for a comprehensive introduction to the **signac** *framework*. -.. _signac: https://signac.io/ -.. _signac-docs: https://docs.signac.io/ +.. _signac: https://signac.readthedocs.io/ +.. _signac-docs: https://signac.readthedocs.io/ Contents -------- @@ -15,7 +15,7 @@ Contents .. toctree:: :hidden: - Go to Framework Documentation + Go to Framework Documentation .. toctree:: :maxdepth: 2 diff --git a/doc/installation.rst b/doc/installation.rst index 275e81ce..68199388 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -11,7 +11,7 @@ The signac framework uses the `NEP 29 deprecation policy Security Guidelines", # noqa:E501 + "'ALLOW_WHERE' is enabled. See also: Security Guidelines", # noqa:E501 "warning", ) raise RuntimeError("ALLOW_WHERE must be enabled for this query.") diff --git a/signac_dashboard/templates/layout.html b/signac_dashboard/templates/layout.html index 481cc642..62281657 100644 --- a/signac_dashboard/templates/layout.html +++ b/signac_dashboard/templates/layout.html @@ -94,7 +94,7 @@

Modules

{% endif %} {# if g.active_page... #} {% else %} {# modules_by_context[context] | length <= 0 #} - + No modules. Add some! {% endif %} {# that checks number of enabled modules #} @@ -199,9 +199,9 @@

{{ APP_NAME }} {{ APP_VERSION }} by the Glotzer Group

-

part of the signac data management framework

+

part of the signac data management framework

- documentation | + documentation | source | license

diff --git a/signac_dashboard/templates/login.html b/signac_dashboard/templates/login.html index e9e5b23c..7b8f854c 100644 --- a/signac_dashboard/templates/login.html +++ b/signac_dashboard/templates/login.html @@ -18,7 +18,7 @@

Login required

Token authentication is enabled. Copy the token from the command line where signac-dashboard was run.

- Read more about security in signac-dashboard. + Read more about security in signac-dashboard.