Skip to content

Navigation Menu

Explore
By size
By industry
By use case
Topics
- AI
- DevOps
- Security
- Software Development
- View all
Explore
- GitHub Sponsors
  Fund open source developers
- The ReadME Project
  GitHub community articles
Repositories
- Enterprise platform
  AI-powered developer platform
Available add-ons
Pricing

Search code, repositories, users, issues, pull requests...

Search

Clear

Search syntax tips

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Name

Query

To see all available qualifiers, see our documentation.

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Dismiss alert

edgexfoundry / edgex-docs Public

Notifications You must be signed in to change notification settings
Fork 86
Star 42

Code
Issues 32
Pull requests 11
Actions
Projects
Security
Insights

Additional navigation options

Code
Issues
Pull requests
Actions
Projects
Security
Insights

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

farshidtz merged 29 commits into edgexfoundry:main from farshidtz:extend-snap-docs

May 6, 2022

Merged

feat: Extend snap getting started docs #751

farshidtz merged 29 commits into edgexfoundry:main from farshidtz:extend-snap-docs

May 6, 2022

Conversation 17 Commits 29 Checks 0 Files changed

Conversation

Copy link

Member

farshidtz commented May 4, 2022

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)

Sorry, something went wrong.

All reactions

farshidtz added 11 commits

May 2, 2022 19:20


          feat(microservices): add snap config section

adc5eb2

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: Extend the edgexfoundry snap docs

a8a045b

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: add config options instructions

a1e38b3

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: Config and edgexfoundry snap updates

557b98d

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: update security config

a65d869

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: simplify sections

08afef9

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: add ui instructions

c214797

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: add reference headers

7e386bf

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: token interface and reference updates

50055f6

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: token interface, collapsable notes

7d91303

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: remove temp snap config pages

353493f

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>

This was referenced May 4, 2022

docs(snap): Remove usage instructions from readme edgexfoundry/app-service-configurable#416

Merged

docs(snap): Move usage instructions to docs edgexfoundry/edgex-ui-go#519

Merged

docs(snap): Move usage instructions to docs edgexfoundry/edgex-cli#440

Merged

farshidtz changed the title ~~Extend snap docs~~ feat: Extend snap getting started docs

farshidtz added 2 commits

May 4, 2022 15:47


          feat: fill eKuiper section

cc7390c

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: add ekuiper, cleanup asc

6c00ca7

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>

farshidtz requested a review from MonicaisHer

May 4, 2022 14:11

farshidtz added kamakura documentation labels

farshidtz added 6 commits

May 5, 2022 09:16


          fix: change to app-options

414f2ef

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          fix: improve tip titles

4a3d0b3

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: add app-rfid-llrp-inventory

97d26b8

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: add device-gpio

5777cb5

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: describe loglevel option

e1252e7

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          feat: add remaining snaps

78e550c

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>

farshidtz marked this pull request as ready for review

May 5, 2022 08:39

MonicaisHer mentioned this pull request

docs(snap): Move usage instructions to docs edgexfoundry/device-rest-go#184

Merged

5 tasks

Copy link

Contributor

MonicaisHer commented May 5, 2022 •

edited

Loading

edgex-go docs(snap): Move usage instructions to docs edgex-go#4006
device-rest-go docs(snap): Move usage instructions to docs device-rest-go#184
app-service-configurable docs(snap): Remove usage instructions from readme app-service-configurable#416
device-gpio docs(snap): Move usage instructions to docs device-gpio#27
device-mqtt-go docs(snap): Move usage instructions to docs device-mqtt-go#377
app-rfid-llrp-inventory docs(snap): Move usage instructions to docs app-rfid-llrp-inventory#79
device-modbus-go docs(snap): Move usage instructions to docs device-modbus-go#342
device-rfid-llrp-go docs(snap): Move usage instructions to docs device-rfid-llrp-go#81
device-snmp-go docs(snap): Move usage instructions to docs device-snmp-go#167
device-camera-go docs(snap): Move usage instructions to docs device-camera-go#209
ui docs(snap): Move usage instructions to docs edgex-ui-go#519
cli docs(snap): Move usage instructions to docs edgex-cli#440

farshidtz reacted with thumbs up emoji

All reactions

👍 1 reaction

Sorry, something went wrong.

MonicaisHer mentioned this pull request

docs(snap): Move usage instructions to docs edgexfoundry/device-mqtt-go#377

Merged

5 tasks

This was referenced May 5, 2022

docs(snap): Move usage instructions to docs edgexfoundry/device-modbus-go#342

Merged

docs(snap): Move usage instructions to docs edgexfoundry/app-rfid-llrp-inventory#79

Merged

docs(snap): Move usage instructions to docs edgexfoundry/device-rfid-llrp-go#81

Merged

docs(snap): Move usage instructions to docs edgexfoundry/device-snmp-go#167

Merged

docs(snap): Move usage instructions to docs edgexfoundry/device-camera-go#209

Merged

MonicaisHer reviewed

View reviewed changes

docs_src/getting-started/Ch-GettingStartedSnapUsers.md Outdated Show resolved Hide resolved


          fix: revert secret store section title

ed17151

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>

MonicaisHer previously approved these changes

View reviewed changes

Copy link

Contributor

MonicaisHer left a comment

There was a problem hiding this 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!

Sorry, something went wrong.

All reactions

farshidtz mentioned this pull request

feat(snap): Add support for environment variable injection edgexfoundry/edgex-go#3986

Merged

5 tasks


          fix: typo and formatting

869e311

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>

farshidtz dismissed MonicaisHer’s stale review via

869e311

May 6, 2022 08:28

MonicaisHer reviewed

View reviewed changes

docs_src/getting-started/Ch-GettingStartedSnapUsers.md Show resolved Hide resolved

farshidtz added 2 commits

May 6, 2022 12:05


          feat: describe device profile uploads

7c9f2c4

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          fix: KONG_ADMIN_JWT_FILE -> KONG_ADMIN_JWT

a994981

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>

MonicaisHer reviewed

View reviewed changes

docs_src/getting-started/Ch-GettingStartedSnapUsers.md Outdated Show resolved Hide resolved

farshidtz added 2 commits

May 6, 2022 12:15


          fix: device profile descr fix

ebb4b88

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          fix: add missing snap name to set command

e0e7a3c

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>

MonicaisHer reviewed

View reviewed changes

docs_src/getting-started/Ch-GettingStartedSnapUsers.md Outdated Show resolved Hide resolved

MonicaisHer reviewed

View reviewed changes

docs_src/getting-started/Ch-GettingStartedSnapUsers.md Outdated Show resolved Hide resolved


          fix: pass consul token in file, rename user jwt for consistency

a95f11f

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>

MonicaisHer reviewed

View reviewed changes

docs_src/getting-started/Ch-GettingStartedSnapUsers.md Outdated Show resolved Hide resolved

MonicaisHer reviewed

View reviewed changes

docs_src/getting-started/Ch-GettingStartedSnapUsers.md Outdated Show resolved Hide resolved


          fix: remove $ rfid app in commands

a1a9159

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>

MonicaisHer reviewed

View reviewed changes

docs_src/getting-started/Ch-GettingStartedSnapUsers.md Outdated Show resolved Hide resolved

farshidtz added 2 commits

May 6, 2022 14:46


          fix: clarify custom TLS example

35252c6

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>


          fix: change tls cert section title

a558346

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>

MonicaisHer approved these changes

View reviewed changes

Copy link

Contributor

MonicaisHer left a comment

There was a problem hiding this 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.

Sorry, something went wrong.

All reactions

farshidtz merged commit ac42a9b into edgexfoundry:main

farshidtz deleted the extend-snap-docs branch

May 6, 2022 13:04

edgex-jenkins added a commit that referenced this pull request


          ci: feat: Extend snap getting started docs (#751)

6bfdd70

Signed-off-by: edgex-jenkins <collab-it+edgex@linuxfoundation.org>

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

Reviewers

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

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.

Footer

© 2024 GitHub, Inc.

Footer navigation

Terms
Privacy
Security
Status
Docs
Contact

You can’t perform that action at this time.