HARMONY-2003: Update doc to reference harmony-service-lib-py README. #687
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
| @@ -46,15 +46,15 @@ then invokes a single service image. If setting up a more complex service chain | |||
|
|
|||
|
|
|||
| # Requirements for Harmony Services | |||
| In order for a service to run in Harmony several things need to be provided as covered in the following sections. A simple reference service, [harmony-service-example](https://github.com/nasa/harmony-service-example), provides examples of each. For examples of services that are being used in production see [harmony-netcdf-to-zarr](https://github.com/nasa/harmony-netcdf-to-zarr) and [podaac-l2ss-py](https://github.com/podaac/l2ss-py). This document describes how to fulfill these requirements in depth. | |||
| In order for a service to run in Harmony, several things need to be provided as covered in the following sections. For examples of Harmony services and development guidance, see [Examples and Guidance](https://github.com/nasa/harmony-service-lib-py/blob/main/README.md#examples-and-guidance). | |||
There was a problem hiding this comment.
This section of the README in harmony-service-lib-py refers right back to this README.
There was a problem hiding this comment.
Yeah I noticed that too... but I think it makes sense for both documents to point to each other since there's some things you do in the harmony repo after you've setup your service using the service adapter. I'm not sure how I'd suggest changing it.
There was a problem hiding this comment.
I removed the harmony-service-lib-py reference back to this README to avoid the possible confusion.
chris-durbin
approved these changes
Jan 30, 2025
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.
Jira Issue ID
HARMONY-2003
Description
Update doc to reference harmony-service-lib-py README.
Local Test Steps
Make sure the documentation makes sense.
PR Acceptance Checklist