fix: Update all doc links in app template to refer to version 2.2 #1105
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
app-service-template/README.md
Outdated
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| This folder contains a buildable/runnable template for a new custom application service based on the Pre-Release 2.x release of the App Functions SDK. | |||
|
|
|||
| > **Note**: If you only need to use the built-in pipeline functions, then it is advisable that you use `App Service Configurable` rather then create a new custom application service. See [here](https://docs.edgexfoundry.org/1.3/microservices/application/AppServiceConfigurable/) for more details on `App Service Configurable` | |||
| > **Note**: If you only need to use the built-in pipeline functions, then it is advisable that you use `App Service Configurable` rather then create a new custom application service. See [here](https://docs.edgexfoundry.org/2.2//microservices/application/AppServiceConfigurable/) for more details on `App Service Configurable` | |||
There was a problem hiding this comment.
remove extra /:
Suggested change
| > **Note**: If you only need to use the built-in pipeline functions, then it is advisable that you use `App Service Configurable` rather then create a new custom application service. See [here](https://docs.edgexfoundry.org/2.2//microservices/application/AppServiceConfigurable/) for more details on `App Service Configurable` | |
| > **Note**: If you only need to use the built-in pipeline functions, then it is advisable that you use `App Service Configurable` rather then create a new custom application service. See [here](https://docs.edgexfoundry.org/2.2/microservices/application/AppServiceConfigurable/) for more details on `App Service Configurable` |
| @@ -48,13 +48,13 @@ type Sample struct { | |||
| } | |||
|
|
|||
| // LogEventDetails is example of processing an Event and passing the original Event to next function in the pipeline | |||
| // For more details on the Context API got here: https://docs.edgexfoundry.org/1.3/microservices/application/ContextAPI/ | |||
| // For more details on the Context API got here: https://docs.edgexfoundry.org/2.2//microservices/application/ContextAPI/ | |||
| func (s *Sample) LogEventDetails(ctx interfaces.AppFunctionContext, data interface{}) (bool, interface{}) { | ||
| lc := ctx.LoggingClient() | ||
| lc.Debugf("LogEventDetails called in pipeline '%s'", ctx.PipelineId()) | ||
|
|
||
| if data == nil { | ||
| // Go here for details on Error Handle: https://docs.edgexfoundry.org/1.3/microservices/application/ErrorHandling/ | ||
| // Go here for details on Error Handle: https://docs.edgexfoundry.org/2.2//microservices/application/ErrorHandling/ |
| @@ -162,7 +162,7 @@ func (s *Sample) OutputXML(ctx interfaces.AppFunctionContext, data interface{}) | |||
|
|
|||
| // This sends the XML as a response. i.e. publish for MessageBus/MQTT triggers as configured or | |||
| // HTTP response to for the HTTP Trigger | |||
| // For more details on the SetResponseData() function go here: https://docs.edgexfoundry.org/1.3/microservices/application/ContextAPI/#complete | |||
| // For more details on the SetResponseData() function go here: https://docs.edgexfoundry.org/2.2//microservices/application/ContextAPI/#complete | |||
| @@ -68,7 +68,7 @@ Timeout = "30s" | |||
| # if not this secion can be removed, but you must make sure EDGEX_SECURITY_SECRET_STORE is set to false | |||
| # Note is database is running in secure more and you have Store and Forward enable you will need to run this | |||
| # service in secure mode. | |||
| # For more deatils about SecretStore: https://docs.edgexfoundry.org/1.3/microservices/security/Ch-SecretStore/ | |||
| # For more deatils about SecretStore: https://docs.edgexfoundry.org/2.2//microservices/security/Ch-SecretStore/ | |||
| @@ -157,15 +157,15 @@ Type="edgex-messagebus" | |||
|
|
|||
| # TODO: Add custom settings needed by your app service or remove if you don't have any settings. | |||
| # This can be any Key/Value pair you need. | |||
| # For more details see: https://docs.edgexfoundry.org/1.3/microservices/application/GeneralAppServiceConfig/#application-settings | |||
| # For more details see: https://docs.edgexfoundry.org/2.2//microservices/application/GeneralAppServiceConfig/#application-settings | |||
Codecov Report
@@ Coverage Diff @@
## main #1105 +/- ##
=======================================
Coverage 68.49% 68.49%
=======================================
Files 37 37
Lines 3034 3034
=======================================
Hits 2078 2078
Misses 827 827
Partials 129 129 Continue to review full report at Codecov.
|
fixes edgexfoundry#1104 Signed-off-by: Leonard Goodell <[email protected]>
lenny-goodell
force-pushed
the
fix-doc-links
branch
from
2e65055 to
f279096
Compare
jim-wang-intel
approved these changes
Apr 28, 2022
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.
fixes #1104
Signed-off-by: Leonard Goodell [email protected]
If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/app-functions-sdk-go/blob/main/.github/CONTRIBUTING.md
PR Checklist
Please check if your PR fulfills the following requirements:
BREAKING CHANGE:describing the break)Testing Instructions
N/A
New Dependency Instructions (If applicable)