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 23a0094 commit 3545197
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/generate-changelog.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
workspace = os.environ["GITHUB_WORKSPACE"]
with open(os.path.join(workspace, "changelog.txt")) as f:
for line in f:
if re.search("\[\d+\.\d+\.\d+\] -- \d{4}-\d{2}-\d{2}", line):
if re.search(r"\[\d+\.\d+\.\d+\] -- \d{4}-\d{2}-\d{2}", line):
if include:
# We're now encountering the second header, so break
break
Expand Down
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 synced_collections project has therefore adopted the [Contributor Covenant Code of Conduct](https://signac.io/conduct/).
The synced_collections project has therefore adopted the [Contributor Covenant Code of Conduct](https://signac.readthedocs.io/conduct/).
Please email [signac-support@umich.edu](mailto:signac-support@umich.edu) if you have any questions or concerns.
10 changes: 5 additions & 5 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/synced_colle

## 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 docstrings, which are published on `https://docs.signac.io/projects/$package`, where `$package` is currently one of `core`, `flow`, `dashboard`, or `synced_collections`.
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 docstrings, which are published on `https://signac.readthedocs.io/projects/$package`, where `$package` is currently one of `core`, `flow`, `dashboard`, or `synced_collections`.

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 @@ -26,7 +26,7 @@ All contributors must agree to the Contributor Agreement ([ContributorAgreement.

### Guideline for Code Contributions

Please see [our contributions guide](https://docs.signac.io/en/latest/community.html#contributions) for detailed development guidelines.
Please see [our contributions guide](https://signac.readthedocs.io/en/latest/community.html#contributions) for detailed development guidelines.
* Use the [OneFlow](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow) model of development:
- Both new features and bug fixes should be developed in branches based on `main`.
- Hotfixes (critical bugs that need to be released *fast*) should be developed in a branch based on the latest tagged release.
Expand All @@ -35,10 +35,10 @@ Please see [our contributions guide](https://docs.signac.io/en/latest/community.
* 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, along with any guides or concept overviews that are specific to synced_collections. Any information relevant to how synced_collections interact with the rest of the framework should go in the [framework documentation](https://docs.signac.io/) ([source](https://github.com/glotzerlab/signac-docs/)).
* Write API documentation in this package, along with any guides or concept overviews that are specific to synced_collections. Any information relevant to how synced_collections interact with the rest of the framework should go 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
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,29 @@
[![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)
[![GitHub Actions](https://github.com/glotzerlab/synced_collections/actions/workflows/run-pytest.yml/badge.svg)](https://github.com/glotzerlab/synced_collections/actions)
[![License](https://img.shields.io/github/license/glotzerlab/synced_collections.svg)](https://github.com/glotzerlab/synced_collections/blob/main/LICENSE.txt)
[![Slack](https://img.shields.io/badge/Slack-chat%20support-brightgreen.svg?style=flat&logo=slack)](https://signac.io/slack-invite/)
[![Slack](https://img.shields.io/badge/Slack-chat%20support-brightgreen.svg?style=flat&logo=slack)](https://signac.readthedocs.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/synced_collections?style=social)](https://github.com/glotzerlab/synced_collections/)
[![PyPI](https://img.shields.io/pypi/v/synced_collections.svg)](https://pypi.org/project/synced_collections/)
[![conda-forge](https://img.shields.io/conda/vn/conda-forge/synced_collections.svg?style=flat)](https://anaconda.org/conda-forge/synced_collections)
[![RTD](https://img.shields.io/readthedocs/synced_collections.svg?style=flat)](https://docs.signac.io)
[![RTD](https://img.shields.io/readthedocs/synced_collections.svg?style=flat)](https://signac.readthedocs.io)
[![PyPI-downloads](https://img.shields.io/pypi/dm/synced_collections.svg?style=flat)](https://pypistats.org/packages/synced_collections)

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 **synced_collections** package provides Pythonic abstractions over various underlying data stores, presenting APIs that behave like standard built-in Python collections like dicts.
**synced_collections** form the backbone of **signac**'s data and metadata storage, but may be used just as easily outside of **signac**.
For instance, users wishing to access a JSON file on disk like a dictionary and automatically persist all changes could use the `synced_collections.JSONDict`.

## Resources

- [Slack Chat Support](https://signac.io/slack-invite/):
- [Slack Chat Support](https://signac.readthedocs.io/slack-invite/):
Get help and ask questions on the **signac** Slack workspace.
- [**signac** website](https://signac.io/):
- [**signac** website](https://signac.readthedocs.io/):
Framework overview and news.
- [Framework documentation](https://docs.signac.io/):
- [Framework documentation](https://signac.readthedocs.io/):
Examples, tutorials, topic guides, and package Python APIs.
- [Package documentation](https://docs.signac.io/projects/synced-collections/):
- [Package documentation](https://signac.readthedocs.io/projects/synced-collections/):
API reference for the **synced_collections** package.

## Installation
Expand All @@ -45,7 +45,7 @@ To install **synced_collections** *via* **pip**, execute:
pip install synced_collections
```

**Detailed information about alternative installation methods can be found in the [documentation](https://docs.signac.io/en/latest/installation.html).**
**Detailed information about alternative installation methods can be found in the [documentation](https://signac.readthedocs.io/en/latest/installation.html).**

## Quickstart

Expand Down Expand Up @@ -74,7 +74,7 @@ $ python -m pytest tests/
## Acknowledgment

When using **synced_collections** as part of your work towards a publication, we would really appreciate that you acknowledge the **signac** frameworkf appropriately.
We have prepared examples on how to do that [here](https://docs.signac.io/en/latest/acknowledge.html).
We have prepared examples on how to do that [here](https://signac.readthedocs.io/en/latest/acknowledge.html).
**Thank you very much!**

The signac framework is a [NumFOCUS Affiliated Project](https://numfocus.org/sponsored-projects/affiliated-projects).
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 @@ synced_collections package documentation
This is documentation for the **synced_collections** 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
6 changes: 3 additions & 3 deletions doc/support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Support and Development
=======================

To get help using the **synced_collections** package, join the `signac Slack workspace <https://signac.io/slack-invite/>`_ or send an email to `signac-support@umich.edu <mailto:signac-support@umich.edu>`_.
To get help using the **synced_collections** package, join the `signac Slack workspace <https://signac.readthedocs.io/slack-invite/>`_ or send an email to `signac-support@umich.edu <mailto:signac-support@umich.edu>`_.

The **synced_collections** package is hosted on `GitHub <https://github.com/glotzerlab/synced_collections>`_ and licensed under the open-source BSD 3-Clause license.
Please use the `repository's issue tracker <https://github.com/glotzerlab/synced_collections/issues>`_ to report bugs or request new features.
Expand All @@ -15,7 +15,7 @@ Code contributions

This project is open-source.
Users are highly encouraged to contribute directly by implementing new features and fixing issues.
Development for packages as part of the **signac** framework should follow the general development guidelines outlined `here <https://docs.signac.io/en/latest/community.html#contributions>`__.
Development for packages as part of the **signac** framework should follow the general development guidelines outlined `here <https://signac.readthedocs.io/en/latest/community.html#contributions>`__.

A brief summary of contributing guidelines are outlined in the `CONTRIBUTING.md <https://github.com/glotzerlab/synced_collections/blob/main/CONTRIBUTING.md>`_ file as part of the repository.
All contributors must agree to the `Contributor Agreement <https://github.com/glotzerlab/synced_collections/blob/main/ContributorAgreement.md>`_ before their pull request can be merged.
Expand Down Expand Up @@ -113,7 +113,7 @@ Then you can build the documentation from within the ``doc/`` directory as part
.. note::

Documentation as part of the package should be largely limited to the API.
More elaborate documentation on how to integrate **synced_collections** into a computational workflow should be documented as part of the `framework documentation <https://docs.signac.io>`_, which is maintained `here <https://github.com/glotzerlab/signac-docs>`__.
More elaborate documentation on how to integrate **synced_collections** into a computational workflow should be documented as part of the `framework documentation <https://signac.readthedocs.io>`_, which is maintained `here <https://github.com/glotzerlab/signac-docs>`__.


Updating the changelog
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ redis = ["redis"]
mongodb = ["pymongo"]

[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/synced_collections/"
Source = "https://github.com/glotzerlab/synced_collections"
Issues = "https://github.com/glotzerlab/synced_collections/issues"
Expand Down

0 comments on commit 3545197

Please sign in to comment.