Skip to content

Commit

Permalink
Update signac links.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed Jan 31, 2025
1 parent 5abbf52 commit cb130cd
Show file tree
Hide file tree
Showing 11 changed files with 26 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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 [[email protected]](mailto:[email protected]) if you have any questions or concerns.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand Down
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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),
}
Expand Down
6 changes: 3 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ signac-dashboard package documentation
This is documentation for the **signac-dashboard** package, which is part of the signac_ framework.
See `here <signac-docs_>`_ 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
--------

.. toctree::
:hidden:

Go to Framework Documentation <https://docs.signac.io/>
Go to Framework Documentation <https://signac.readthedocs.io/>

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The signac framework uses the `NEP 29 deprecation policy <https://numpy.org/neps
.. _conda: https://docs.conda.io/
.. _conda-forge: https://conda-forge.org/
.. _pip: https://pip.pypa.io/
.. _signac: https://signac.io/
.. _signac: https://signac.readthedocs.io/
.. _flask: https://flask.palletsprojects.com/

Install with conda
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ dependencies = [
signac-dashboard = "signac_dashboard.__main__:main"

[project.urls]
Homepage = "https://signac.io"
Documentation = "https://docs.signac.io"
Homepage = "https://signac.readthedocs.io"
Documentation = "https://signac.readthedocs.io/"
Download = "https://pypi.org/project/signac-dashboard/"
Source = "https://github.com/glotzerlab/signac-dashboard"
Issues = "https://github.com/glotzerlab/signac-dashboard/issues"
Expand Down
2 changes: 1 addition & 1 deletion signac_dashboard/dashboard.py
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ def _job_search(self, query):
flash(
"Searches using $where allow arbitrary code execution and "
"are only allowed when the configuration option "
"'ALLOW_WHERE' is enabled. See also: <a href=\"https://docs.signac.io/projects/dashboard/en/latest/security.html\">Security Guidelines</a>", # noqa:E501
"'ALLOW_WHERE' is enabled. See also: <a href=\"https://signac.readthedocs.io/projects/dashboard/en/latest/security.html\">Security Guidelines</a>", # noqa:E501
"warning",
)
raise RuntimeError("ALLOW_WHERE must be enabled for this query.")
Expand Down
6 changes: 3 additions & 3 deletions signac_dashboard/templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ <h2 class="subtitle is-4">Modules</h2>
{% endif %} {# if g.active_page... #}

{% else %} {# modules_by_context[context] | length <= 0 #}
<a href="https://docs.signac.io/projects/dashboard/en/latest/api.html#dashboard-modules">
<a href="https://signac.readthedocs.io/projects/dashboard/en/latest/api.html#dashboard-modules">
No modules. Add some!
</a>
{% endif %} {# that checks number of enabled modules #}
Expand Down Expand Up @@ -199,9 +199,9 @@ <h2 class="subtitle">
<div class="container">
<div class="has-text-centered">
<p><strong>{{ APP_NAME }} {{ APP_VERSION }}</strong> by <a href="https://glotzerlab.engin.umich.edu">the Glotzer Group</a></p>
<p>part of the <a href="https://signac.io/"><strong>signac</strong></a> data management framework</p>
<p>part of the <a href="https://signac.readthedocs.io/"><strong>signac</strong></a> data management framework</p>
<p>
<a href="https://docs.signac.io/projects/dashboard/en/latest/">documentation</a> |
<a href="https://signac.readthedocs.io/projects/dashboard/en/latest/">documentation</a> |
<a href="https://github.com/glotzerlab/signac-dashboard/">source</a> |
<a href="https://github.com/glotzerlab/signac-dashboard/blob/main/LICENSE.txt">license</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion signac_dashboard/templates/login.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ <h4 class="title">Login required</h4>
Token authentication is enabled. Copy the token from the command line where signac-dashboard was run.
</p>
<p>
<a href="https://docs.signac.io/projects/dashboard/en/latest/security.html" target="_blank">Read more about security in signac-dashboard.</a>
<a href="https://signac.readthedocs.io/projects/dashboard/en/latest/security.html" target="_blank">Read more about security in signac-dashboard.</a>
</p>
</form>
</div>
Expand Down

0 comments on commit cb130cd

Please sign in to comment.