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

docs: add snap/README.md and update README.md #470

Merged
merged 8 commits into from
Nov 5, 2021
Merged

docs: add snap/README.md and update README.md #470

merged 8 commits into from
Nov 5, 2021

Conversation

MonicaisHer
Copy link
Contributor

Signed-off-by: Mengyi mengyi.wang@canonical.com

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

PR Checklist

Please check if your PR fulfills the following requirements:

  • I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
  • I am not introducing a new dependency (add notes below if you are)
  • I have added unit tests for the new feature or bug fix (if not, why?)
  • I have fully tested (add details below) this the new feature or bug fix (if not, why?)
  • I have opened a PR for the related docs change (if not, why?)

Testing Instructions

N/A

New Dependency Instructions (If applicable)

@MonicaisHer
Copy link
Contributor Author

MonicaisHer commented Nov 3, 2021 •
edited
Loading

Could you please review? @badboy-huaqiao @farshidtz @siggiskulason Thanks!

@MonicaisHer
docs(snap): add README.md
cebb575 
Signed-off-by: Mengyi <mengyi.wang@canonical.com>
@MonicaisHer MonicaisHer changed the title feat(snap): add README.md docs(snap): add README.md Nov 3, 2021
@MonicaisHer MonicaisHer mentioned this pull request Nov 3, 2021
Merged
1 task
@MonicaisHer
docs: add snap installation in README.md
cd6bd66 
Signed-off-by: Mengyi <mengyi.wang@canonical.com>
@MonicaisHer MonicaisHer changed the title docs(snap): add README.md docs: add snap/README.md and update README.md Nov 3, 2021
@badboy-huaqiao
Copy link
Member

badboy-huaqiao commented Nov 4, 2021 •
edited
Loading

@MonicaisHer @farshidtz @siggiskulason it looks like jenkins didn't pass the build

@MonicaisHer
Copy link
Contributor Author

@MonicaisHer @farshidtz @siggiskulason it looks like jenkins didn't pass the build

Thanks @badboy-huaqiao, , do you have any idea how to re-trigger the Jenkins pipeline? I had tried force push, didn't work. Also, there is no error appears in the Jenkins, and LF Post Build Actions passed. Seems like it just needs to a re-build.

@badboy-huaqiao
Copy link
Member

@MonicaisHer you can try to modify somewhere of the file you submit and then execute push operation again, but we should contact devops team why not pass, you can send message to them on slack devops channel

@MonicaisHer
docs(snap): update snap/README.md
3ccc174 
Signed-off-by: Mengyi <mengyi.wang@canonical.com>
@MonicaisHer
Copy link
Contributor Author

@badboy-huaqiao Ok, I did it. The Jenkins is re-triggered now. I also asked on the slack DevOps channel.

farshidtz
farshidtz requested changes Nov 4, 2021
View reviewed changes
README.md Outdated Show resolved Hide resolved
snap/README.md Outdated Show resolved Hide resolved
snap/README.md Outdated Show resolved Hide resolved
snap/README.md Outdated Show resolved Hide resolved
snap/README.md Outdated Show resolved Hide resolved
snap/README.md Outdated Show resolved Hide resolved
snap/README.md Outdated Show resolved Hide resolved
snap/README.md Outdated Show resolved Hide resolved
@MonicaisHer
docs: add snap/README.md and update README.md
0d6ed87 
- update installation section in snap/README.md
- simplify JWT token section in snap/README.md
- simplify edgexfoundry snap section in snap/README.md
- update format, images and wording in snap/README.md
- simplify snap section in README.md
- add two README related images in snap/local/assets

Signed-off-by: Mengyi <mengyi.wang@canonical.com>
@MonicaisHer
docs: update images' relative path in snap/README.md
1b5f39b 
Signed-off-by: Mengyi <mengyi.wang@canonical.com>
farshidtz
farshidtz reviewed Nov 4, 2021
View reviewed changes
snap/README.md Outdated

### Using the edgex-ui snap

Open your browser [http://localhost:4000](http://localhost:4000/):![img](https://lh5.googleusercontent.com/OzQFePPICpiaMTxEm8cnxaCFn7ageCbLR9J5TpzkGtmRIip-pB02D7H994gKvVS2CTD3YChngX72SGtaLxEVjdC4j9bgYTFCGHvRfzr25i-qIk3UNMprucpPa2oBpgI_W7KZVJ4n)
Open your browser [http://localhost:4000](http://localhost:4000/):![](/home/mengyi/Desktop/EdgeX_14/edgex-ui-go/snap/local/assets/ui-login.jpg)
Copy link
Member

Choose a reason for hiding this comment

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

Wrong image path.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have updated this path. This commit you reviewed was out of date.

farshidtz
farshidtz reviewed Nov 4, 2021
View reviewed changes
snap/README.md Outdated

Please use the JWT token we generated above to log in the UI homepage:![img](https://lh3.googleusercontent.com/iE5qQKWkpQsBVmjsKDmgcTO6JDc40hbb-3kp7GGJnWDWj2bH4afOFCGW7WSNNIFIMiUtV5x1duCbVAdd6D2hNS49CspfTaToVZaH7aK3I50uHKRPcfAvQ9miZqprrc7Q--ugzAfh)
![](/home/mengyi/Desktop/EdgeX_14/edgex-ui-go/snap/local/assets/ui-homepage.jpg)
Copy link
Member

Choose a reason for hiding this comment

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

Wrong image path.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have updated this path. This commit you reviewed was out of date.

@badboy-huaqiao
Copy link
Member

@farshidtz @MonicaisHer is it ready?

@farshidtz farshidtz mentioned this pull request Nov 5, 2021
Merged
5 tasks
@farshidtz
docs: improve instructions (#1)
9d0ce14 
* docs: improve instructions

* edgexfoundry installation reference
* enabling dependencies
* service management wrt. current state
* docs: fix typos

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
@MonicaisHer MonicaisHer mentioned this pull request Nov 5, 2021
Closed
@MonicaisHer
docs: link an issue in snap/README.md
404f2e4 
Signed-off-by: Mengyi <mengyi.wang@canonical.com>
@MonicaisHer
docs(snap): update edgexfoundry snap in snap/README.md
095502c 
Signed-off-by: Mengyi <mengyi.wang@canonical.com>
farshidtz
farshidtz approved these changes Nov 5, 2021
View reviewed changes
Copy link
Member

@farshidtz farshidtz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks. Looks good.
It's probably best to squash and merge.

@badboy-huaqiao
Copy link
Member

@farshidtz ok, thanks for your advice, @MonicaisHer it looks like it's ready, will be merged if you think there is no others work need to do.

badboy-huaqiao
badboy-huaqiao approved these changes Nov 5, 2021
View reviewed changes
Copy link
Member

@badboy-huaqiao badboy-huaqiao left a comment

Choose a reason for hiding this comment

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

LGTM

@MonicaisHer
Copy link
Contributor Author

Thanks @badboy-huaqiao it's ready.

@badboy-huaqiao badboy-huaqiao merged commit 26e4c85 into edgexfoundry:main Nov 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@farshidtz farshidtz farshidtz approved these changes

@badboy-huaqiao badboy-huaqiao badboy-huaqiao approved these changes

@siggiskulason siggiskulason Awaiting requested review from siggiskulason

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

Successfully merging this pull request may close these issues.
3 participants
@MonicaisHer @badboy-huaqiao @farshidtz