Skip to content

Commit

Permalink
Merge pull request #237 from lsst-sqre/tickets/DM-47710/backport-more…
Browse files Browse the repository at this point in the history
…-slack-reference-changes

DM-47710: backport `#dm-docs-support`, `#square-docs-support`
  • Loading branch information
fajpunk authored Nov 21, 2024
2 parents 8413cfe + 9e65885 commit da9d9bb
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Here are some ways to get help with Documenteer:

- [Documentation](https://documenteer.lsst.io)
- [Ask a question in #dm-docs-support (for Rubin staff)](https://lsstc.slack.com/archives/C2B6DQBAL)
- [Ask a question in #square-docs-support (for Rubin staff)](https://rubin-obs.slack.com/archives/C07QK9N14BY)
- [Post a GitHub issue](https://github.com/lsst-sqre/documenteer/issues/new)
2 changes: 1 addition & 1 deletion docs/_rst_epilog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.. _sphinxcontrib-mermaid: https://github.com/mgaitan/sphinxcontrib-mermaid
.. _Diagrams: https://diagrams.mingrammer.com/
.. _sphinx-diagrams: https://github.com/j-martin/sphinx-diagrams
.. _`#dm-docs-support`: https://lsstc.slack.com/archives/C2B6DQBAL
.. _`#square-docs-support`: https://rubin-obs.slack.com/archives/C07QK9N14BY
.. _`DMTN-030`:
.. _`DMTN-030 Science Pipelines Documentation Design`: https://dmtn-030.lsst.io
.. _`Google Developer Style Guide`: https://developers.google.com/style/
Expand Down
8 changes: 4 additions & 4 deletions docs/technotes/migrate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ You might also want to run the linter to check links and find common issues:
make lint

If you have any questions or issues about the build, you should still proceed with committing and creating a pull request (see next step).
This way you can link to the repository when you reach out for help in `#dm-docs-support`_ on Slack.
This way you can link to the repository when you reach out for help in `#square-docs-support`_ on Slack.

Step 7. Commit the migration, pull request, and merge
=====================================================
Expand All @@ -145,7 +145,7 @@ GitHub Actions will build the technote and publish a preview version that is lin

If the build works, you can merge the pull request.

If there are build errors, you can reach out to `#dm-docs-support`_ on Slack for help.
If there are build errors, you can reach out to `#square-docs-support`_ on Slack for help.
Include the repository URL and ideally a link to the pull request or GitHub Actions workflow run that failed.

.. _technote-migration-detailed:
Expand Down Expand Up @@ -214,7 +214,7 @@ For most technotes, the :file:`conf.py` file should be a single line:
from documenteer.conf.technote import * # noqa: F401, F403
If your :file:`conf.py` file has additional content, some of that configuration may be migrated to :file:`technote.toml`.
Reach out to `#dm-docs-support`_ on Slack for advice.
Reach out to `#square-docs-support`_ on Slack for advice.

index.rst file (updated)
------------------------
Expand Down Expand Up @@ -416,7 +416,7 @@ The Python dependencies for your technote are listed in a :file:`requirements.tx

.. note::

If your technote has additional dependencies listed, you can reach out to `#dm-docs-support`_ on Slack if you are unsure whether they are part of the Sphinx build process or separate packages needed for any custom document preprocessing.
If your technote has additional dependencies listed, you can reach out to `#square-docs-support`_ on Slack if you are unsure whether they are part of the Sphinx build process or separate packages needed for any custom document preprocessing.

tox.ini file (added)
--------------------
Expand Down

0 comments on commit da9d9bb

Please sign in to comment.