Add instructions about adding package to pipelines.lsst.io #491
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arunkannawadi
force-pushed
the
u/kannawad-documenting-new-package
branch
from
d02365a
to
3df6bda
Compare
jonathansick
requested changes
Jul 25, 2021
There was a problem hiding this comment.
Thanks, this is a good idea to cross-reference here.
These steps are already documented in https://developer.lsst.io/stack/add-a-package-to-pipelines-lsst-io.html, though, so we'd rather not duplicate details about the pipelines_lsst_io table file across two pages. Could you please re-write the paragraph so that it links to that page to avoid duplication of content? I've included suggested content.
| @@ -37,6 +37,8 @@ The new package then needs to be added to the :file:`ups/*.table` file (and poss | |||
| Table files should use ``setupRequired(package_name)`` or ``setupOptional(package_name)`` as necessary; test data packages are usually optional to allow releases to be made without requiring large additional data packages to be included. | |||
| Packages that use optional dependencies must be written to ensure that they can pass their unit tests when the package is not available. | |||
|
|
|||
| The new package may be added to the :file:`ups/pipelines_lsst_io.table` file in `lsst/pipelines_lsst_io`_ repository so that its documentation is built as HTML pages and made available at https://pipelines.lsst.io/v/daily. | |||
There was a problem hiding this comment.
Suggested change
| The new package may be added to the :file:`ups/pipelines_lsst_io.table` file in `lsst/pipelines_lsst_io`_ repository so that its documentation is built as HTML pages and made available at https://pipelines.lsst.io/v/daily. | |
| Finally, if the package is part of the LSST Science Pipelines, you should include it in the Pipelines documentation, https://pipelines.lsst.io. | |
| See :doc:`/stack/add-a-package-to-pipelines-lsst-io` for instructions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.