Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Extend snap getting started docs #751

Merged
merged 29 commits into from
May 6, 2022
Merged

feat: Extend snap getting started docs #751

merged 29 commits into from
May 6, 2022

Conversation

farshidtz
Copy link
Member

This PR moves the snap docs from snap/READMEs to docs. The documentation is extended and updated to cover the new snap options developed in Kamakura, among other improvements.

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)

farshidtz added 11 commits May 2, 2022 19:20
@farshidtz
feat(microservices): add snap config section
adc5eb2 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: Extend the edgexfoundry snap docs
a8a045b 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: add config options instructions
a1e38b3 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: Config and edgexfoundry snap updates
557b98d 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: update security config
a65d869 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: simplify sections
08afef9 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: add ui instructions
c214797 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: add reference headers
7e386bf 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: token interface and reference updates
50055f6 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: token interface, collapsable notes
7d91303 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: remove temp snap config pages
353493f 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
This was referenced May 4, 2022
Merged
Merged
Merged
@farshidtz farshidtz changed the title Extend snap docs feat: Extend snap getting started docs May 4, 2022
farshidtz added 2 commits May 4, 2022 15:47
@farshidtz
feat: fill eKuiper section
cc7390c 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: add ekuiper, cleanup asc
6c00ca7 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz farshidtz requested a review from MonicaisHer May 4, 2022 14:11
farshidtz added 6 commits May 5, 2022 09:16
@farshidtz
fix: change to app-options
414f2ef 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
fix: improve tip titles
4a3d0b3 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: add app-rfid-llrp-inventory
97d26b8 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: add device-gpio
5777cb5 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: describe loglevel option
e1252e7 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
feat: add remaining snaps
78e550c 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz farshidtz marked this pull request as ready for review May 5, 2022 08:39
@MonicaisHer MonicaisHer mentioned this pull request May 5, 2022
Merged
5 tasks
@MonicaisHer
Copy link
Contributor

MonicaisHer commented May 5, 2022 •
edited
Loading

@MonicaisHer MonicaisHer mentioned this pull request May 5, 2022
Merged
5 tasks
This was referenced May 5, 2022
Merged
Merged
Merged
Merged
Merged
@farshidtz
fix: revert secret store section title
ed17151 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
MonicaisHer
MonicaisHer previously approved these changes May 6, 2022
View reviewed changes
Copy link
Contributor

@MonicaisHer MonicaisHer left a comment

Choose a reason for hiding this comment

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

@farshidtz Thanks a lot, looks good!

@farshidtz farshidtz mentioned this pull request May 6, 2022
Merged
5 tasks
@farshidtz
fix: typo and formatting
869e311 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
farshidtz added 2 commits May 6, 2022 12:05
@farshidtz
feat: describe device profile uploads
7c9f2c4 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
fix: KONG_ADMIN_JWT_FILE -> KONG_ADMIN_JWT
a994981 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
farshidtz added 2 commits May 6, 2022 12:15
@farshidtz
fix: device profile descr fix
ebb4b88 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
fix: add missing snap name to set command
e0e7a3c 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
fix: remove $ rfid app in commands
a1a9159 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
farshidtz added 2 commits May 6, 2022 14:46
@farshidtz
fix: clarify custom TLS example
35252c6 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
@farshidtz
fix: change tls cert section title
a558346 
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
MonicaisHer
MonicaisHer approved these changes May 6, 2022
View reviewed changes
Copy link
Contributor

@MonicaisHer MonicaisHer left a comment

Choose a reason for hiding this comment

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

@farshidtz Thank you! Looks good.

@farshidtz farshidtz merged commit ac42a9b into edgexfoundry:main May 6, 2022
@farshidtz farshidtz deleted the extend-snap-docs branch May 6, 2022 13:04
edgex-jenkins added a commit that referenced this pull request May 6, 2022
@edgex-jenkins
ci: feat: Extend snap getting started docs (#751)
6bfdd70 
Signed-off-by: edgex-jenkins <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MonicaisHer MonicaisHer MonicaisHer approved these changes

Assignees
No one assigned
Labels
documentation kamakura
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@farshidtz @MonicaisHer