Skip to content

feat: Document the summary of API changes in v3#1065

Merged
lenny-goodell merged 2 commits intoedgexfoundry:mainfrom
jumpingliu:issue-985
May 22, 2023
Merged

feat: Document the summary of API changes in v3#1065
lenny-goodell merged 2 commits intoedgexfoundry:mainfrom
jumpingliu:issue-985

Conversation

@jumpingliu
Copy link
Contributor

@jumpingliu jumpingliu commented May 15, 2023 •
edited
Loading

close #985

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-docs/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

  • Changes have been rendered and validated locally using mkdocs-material (see edgex-docs README)

lenny-goodell
lenny-goodell requested changes May 15, 2023
View reviewed changes
@jumpingliu jumpingliu marked this pull request as ready for review May 16, 2023 10:49
@jumpingliu jumpingliu requested a review from lenny-goodell May 16, 2023 10:51
lenny-goodell
lenny-goodell requested changes May 16, 2023
View reviewed changes
Copy link
Member

@lenny-goodell lenny-goodell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please additionally add service specific config changes and link to common config migration to each of the follwoing

  • core command
    • Removed RequireMessageBus
    • MessageQueue.External moved to ExternalMQTT
  • support notifications
    • No service specific, just need link to common config migration
  • support scheduler
    • RequireMessageBus removed
    • AuthMethod added to IntervalActions.ScrubAged

@jumpingliu
Copy link
Contributor Author

jumpingliu commented May 17, 2023

@lenny-intel
Thanks for the comment, updated at 6fb9732

@jumpingliu jumpingliu requested a review from lenny-goodell May 17, 2023 10:07
lenny-goodell
lenny-goodell requested changes May 17, 2023
View reviewed changes
@lenny-goodell
Copy link
Member

lenny-goodell commented May 17, 2023

@jumpingliu , your last commit is failing the Semantic PR checker. Please amend the commit message to conform with Convectional Commit guidelines as you did with your first commit.

@jumpingliu jumpingliu force-pushed the issue-985 branch 2 times, most recently from 1191a09 to a5bc8fd Compare May 19, 2023 09:32
cloudxxx8
cloudxxx8 reviewed May 19, 2023
View reviewed changes
cloudxxx8
cloudxxx8 reviewed May 19, 2023
View reviewed changes
@jumpingliu jumpingliu force-pushed the issue-985 branch 2 times, most recently from 8d1c496 to a0ba7ef Compare May 19, 2023 10:06
@jumpingliu
Copy link
Contributor Author

jumpingliu commented May 19, 2023

@lenny-intel @cloudxxx8
Thanks for the review comment, updated.

cloudxxx8
cloudxxx8 requested changes May 21, 2023
View reviewed changes
@jumpingliu
feat: Document the summary of API changes in v3
8e32898 
Signed-off-by: melody <melody@iotechsys.com>
@jumpingliu jumpingliu force-pushed the issue-985 branch 2 times, most recently from 3effeef to 38d443a Compare May 22, 2023 03:55
@jumpingliu jumpingliu mentioned this pull request May 22, 2023
Closed
@jumpingliu
feat: update docs per request change
651ec09 
Signed-off-by: melody <melody@iotechsys.com>
@jumpingliu jumpingliu requested a review from cloudxxx8 May 22, 2023 09:03
cloudxxx8
cloudxxx8 approved these changes May 22, 2023
View reviewed changes
Copy link
Member

@cloudxxx8 cloudxxx8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

lenny-goodell
lenny-goodell approved these changes May 22, 2023
View reviewed changes
Copy link
Member

@lenny-goodell lenny-goodell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lenny-goodell lenny-goodell merged commit 7f564ad into edgexfoundry:main May 22, 2023
edgex-jenkins added a commit that referenced this pull request May 22, 2023
@edgex-jenkins
ci: feat: Document the summary of API changes in v3 (#1065)
23756aa 
Signed-off-by: edgex-jenkins <collab-it+edgex@linuxfoundation.org>
@jumpingliu jumpingliu deleted the issue-985 branch May 22, 2023 16:55
@lenny-goodell lenny-goodell linked an issue May 22, 2023 that may be closed by this pull request
[V3 Migration Docs] Core/Support Service V3 Migration Guide #1056
Closed
@lenny-goodell
Copy link
Member

lenny-goodell commented May 22, 2023

@jumpingliu , in the future , please always complete the PR checklist on all PRs.
For docs PR it is very important to render your changes locally (make serve and http://localhost:8008) and verify every link you have created or changed. Links to the docs from within the docs should always be relative and since they get rendered, the .md must be removed.
See my PR to correct links from your PR: #1077

@jumpingliu
Copy link
Contributor Author

jumpingliu commented May 23, 2023

@lenny-intel
Thank you, Lenny. I did render my changes locally by make serve but didn't check twice, sorry about that. I'll keep it in mind next time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cloudxxx8 cloudxxx8 cloudxxx8 approved these changes

@lenny-goodell lenny-goodell lenny-goodell approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[V3 Migration Docs] Core/Support Service V3 Migration Guide Document the summary of data model changes in v3

3 participants

@jumpingliu @lenny-goodell @cloudxxx8