Skip to content

Commit

Permalink
Rename "Contributing" to Design and development
Browse files Browse the repository at this point in the history
Note that the double anchor label is designed so that we don't break
links that might have used the "-contributing" anchor.
  • Loading branch information
jonathansick committed Jan 7, 2020
1 parent 7ccd3b4 commit 2081d3c
Show file tree
Hide file tree
Showing 7 changed files with 44 additions and 12 deletions.
8 changes: 8 additions & 0 deletions project_templates/stack_package/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Change log

## 2020-01-07

- Rename the "Contributing" section of the module homepage to "Design and development."
This section can be used more broadly to contain documentation oriented to internal developers.
Pages linked from this section should be contained in a subdirectory named `dev`.

[DM-21228](https://jira.lsstcorp.org/browse/DM-21228)

## 2020-01-06

- Add a "Pipeline tasks" section to the module homepage template.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,21 @@ lsst.example
.. :maxdepth: 1
.. _lsst.example-contributing:
.. _lsst.example-dev:

Contributing
============
Design and development
======================

``lsst.example`` is developed at https://github.com/lsst/example.
You can find Jira issues for this module under the `example <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20example>`_ component.

.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
.. All design and development pages must be maintained in a "dev" subdirectory.
.. .. toctree::
.. :maxdepth: 1
..
.. dev/page
.. _lsst.example-command-line-taskref:

Expand Down
8 changes: 6 additions & 2 deletions project_templates/stack_package/example_dds/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,21 @@ lsst.example.dds
.. :maxdepth: 1
.. _lsst.example.dds-contributing:
.. _lsst.example.dds-dev:

Contributing
============
Design and development
======================

``lsst.example.dds`` is developed at https://github.com/lsst/example_dds.
You can find Jira issues for this module under the `example_dds <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20example_dds>`_ component.

.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
.. All design and development pages must be maintained in a "dev" subdirectory.
.. .. toctree::
.. :maxdepth: 1
..
.. dev/page
.. _lsst.example.dds-command-line-taskref:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,21 @@ lsst.example.pythononly
.. :maxdepth: 1
.. _lsst.example.pythononly-contributing:
.. _lsst.example.pythononly-dev:

Contributing
============
Design and development
======================

``lsst.example.pythononly`` is developed at https://github.com/lsst/example_pythononly.
You can find Jira issues for this module under the `example_pythononly <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20example_pythononly>`_ component.

.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
.. All design and development pages must be maintained in a "dev" subdirectory.
.. .. toctree::
.. :maxdepth: 1
..
.. dev/page
.. _lsst.example.pythononly-command-line-taskref:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,21 @@ lsst.example.standalone
.. :maxdepth: 1
.. _lsst.example.standalone-contributing:
.. _lsst.example.standalone-dev:

Contributing
============
Design and development
======================

``lsst.example.standalone`` is developed at https://github.com/lsst/example_standalone.
You can find Jira issues for this module under the `example_standalone <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20example_standalone>`_ component.

.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
.. All design and development pages must be maintained in a "dev" subdirectory.
.. .. toctree::
.. :maxdepth: 1
..
.. dev/page
.. _lsst.example.standalone-command-line-taskref:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,21 @@ lsst.example.subpackage
.. :maxdepth: 1
.. _lsst.example.subpackage-contributing:
.. _lsst.example.subpackage-dev:

Contributing
============
Design and development
======================

``lsst.example.subpackage`` is developed at https://github.com/lsst/example_subpackage.
You can find Jira issues for this module under the `example_subpackage <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20example_subpackage>`_ component.

.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
.. All design and development pages must be maintained in a "dev" subdirectory.
.. .. toctree::
.. :maxdepth: 1
..
.. dev/page
.. _lsst.example.subpackage-command-line-taskref:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,21 @@
.. :maxdepth: 1
.. _{{ cookiecutter.python_module }}-contributing:
.. _{{ cookiecutter.python_module }}-dev:

Contributing
============
Design and development
======================

``{{ cookiecutter.python_module }}`` is developed at https://github.com/{{ cookiecutter.github_org }}/{{ cookiecutter.package_name }}.
You can find Jira issues for this module under the `{{ cookiecutter.package_name }} <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20{{ cookiecutter.package_name }}>`_ component.

.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
.. All design and development pages must be maintained in a "dev" subdirectory.
.. .. toctree::
.. :maxdepth: 1
..
.. dev/page
{%- if cookiecutter.has_tasks == "True" %}

.. _{{ cookiecutter.python_module }}-command-line-taskref:
Expand Down

0 comments on commit 2081d3c

Please sign in to comment.