docs: update the image in the USER_GUIDE.md #1683 #1689

iamayushdas · 2021-03-30T02:29:04Z

Please answer these questions before submitting a pull request, or your PR will get closed.

Why submit this pull request?

Bugfix
New feature provided
Improve performance
Backport patches

What changes will this PR take into?
updated the screenshots of USER_GUIDE
Please update this section with detailed description.

Related issues

fix/resolve #1683

Checklist:

Did you explain what problem does this PR solve? Or what new features have been added?
Have you added corresponding test cases?
Have you modified the corresponding document?
Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

…o sidebar

codecov-io · 2021-03-30T03:26:21Z

Codecov Report

Merging #1689 (f3f595b) into master (88f3232) will increase coverage by 1.57%.
The diff coverage is 75.00%.

@@            Coverage Diff             @@
##           master    #1689      +/-   ##
==========================================
+ Coverage   72.41%   73.99%   +1.57%     
==========================================
  Files         133       86      -47     
  Lines        5728     2615    -3113     
  Branches      666      668       +2     
==========================================
- Hits         4148     1935    -2213     
+ Misses       1337      680     -657     
+ Partials      243        0     -243

Flag	Coverage Δ
backend-e2e-test	`?`
backend-e2e-test-ginkgo	`?`
backend-unit-test	`?`
frontend-e2e-test	`73.99% <75.00%> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
web/src/pages/Consumer/Create.tsx	`76.08% <ø> (ø)`
web/src/pages/Plugin/List.tsx	`96.15% <ø> (ø)`
web/src/pages/Service/Create.tsx	`96.42% <ø> (+1.78%)`	⬆️
web/src/pages/Upstream/Create.tsx	`79.41% <50.00%> (-1.84%)`	⬇️
web/src/components/Plugin/PluginDetail.tsx	`65.45% <100.00%> (ø)`
web/src/pages/Plugin/PluginMarket.tsx	`100.00% <100.00%> (ø)`
.../internal/handler/authentication/authentication.go
api/internal/filter/schema.go
api/internal/conf/conf.go
api/internal/utils/runtime/runtime.go
... and 43 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 88f3232...f3f595b. Read the comment docs.

iamayushdas · 2021-03-30T03:30:52Z

@nic-chen @Firstsawyou @liuxiran can you check for the failing test?

juzhiyuan · 2021-03-30T07:06:38Z

https://github.com/apache/apisix-dashboard/pull/1689/checks?check_run_id=2224758948#step:5:217

bisakhmondal · 2021-03-30T07:08:47Z

Hii, it seems the failed test is unrelated to this PR. Can we retrigger the actions @juzhiyuan?

iamayushdas · 2021-03-30T08:48:12Z

https://github.com/apache/apisix-dashboard/pull/1689/checks?check_run_id=2224758948#step:5:217

This isn't my fault ,then?

iamayushdas · 2021-03-30T08:48:48Z

Hii, it seems the failed test is unrelated to this PR. Can we retrigger the actions @juzhiyuan?

Yes i think we have to retrigger

juzhiyuan · 2021-03-30T10:40:31Z

@bisakhmondal @iamayushdas Ya, that's due to Backend, just wait for @nic-chen @starsz to fix.

nic-chen · 2021-03-31T05:13:57Z

@iamayushdas

This is because when verifying the version number, the . In 2.4 is used as a regular expression to match all strings.

You could submit another commit to avoid this problem.

To fix this problem, we could change this line of code
https://github.com/apache/apisix-dashboard/blob/master/api/test/shell/cli_test.sh#L177
to :

if [[ `grep -c -w "${VERSION}" ${STDOUT}` -ne '1' ]]; then

I think you could submit another PR to fix it.

Thanks.

iamayushdas · 2021-03-31T05:25:26Z

@iamayushdas

This is because when verifying the version number, the . In 2.4 is used as a regular expression to match all strings.

You could submit another commit to avoid this problem.

To fix this problem, we could change this line of code

https://github.com/apache/apisix-dashboard/blob/master/api/test/shell/cli_test.sh#L177

to :
if [[ `grep -c -w "${VERSION}" ${STDOUT}` -ne '1' ]]; then
I think you could submit another PR to fix it.

Thanks.

On it! 😊

juzhiyuan · 2021-03-31T06:29:07Z

related PR: #1696

iamayushdas · 2021-04-01T16:10:58Z

Could you please retrigger CI @juzhiyuan

starsz · 2021-04-02T00:51:26Z

Could you please retrigger CI @juzhiyuan

Since PR #1696 is merged. I think you should merge the master branch and fix the conflicts.
Then the CI can be passed.

iamayushdas · 2021-04-02T15:49:01Z

Could you please retrigger CI @juzhiyuan

Since PR #1696 is merged. I think you should merge the master branch and fix the conflicts.

Then the CI can be passed.

Have a review to this😀

docs/en/latest/USER_GUIDE.md

iamayushdas · 2021-04-03T14:28:14Z

@juzhiyuan have a look to this

juzhiyuan · 2021-04-04T00:11:56Z

docs/en/latest/USER_GUIDE.md

@@ -59,7 +59,7 @@ We can debug a route both published or offline with the online debug function, w

 2. Debug a offline route

-![route-debug-offline](../../assets/images/route-debug-offline.png)
+![route-debug-offline](https://user-images.githubusercontent.com/40708551/112923419-e5cd7280-912b-11eb-8e7e-57c3c4fe31ef.png)


actually, it supports not only Upstream URL, but also API Gateway's Endpoint

imjoey · 2021-04-04T00:28:20Z

docs/en/latest/USER_GUIDE.md


 We support the monitor page by referencing it in [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe). Before accessing [Grafana](https://grafana.com/), please Enable [`allow_embedding=true`](https://grafana.com/docs/grafana/latest/administration/configuration/#allow_embedding), which defaults to `false`. This causes the browser to fail to render Grafana pages properly due to security policies.

-![metrics-en](../../assets/images/metrics-en.png)
+![Dashboard-en](https://user-images.githubusercontent.com/40708551/112922395-0eed0380-912a-11eb-8c92-4c67d2bae4a8.png)


@iamayushdas thank you for this. I was wondering that where the new image file is located.

GitHub CDN?

GitHub CDN?

Yep, absolutely I think. My concern is how could us maintain these images. Previous images were maintained in this repository, while the new images seem not.

@iamayushdas thank you for this. I was wondering that where the new image file is located.

My pleasure sir!

🤔 that's a problem.

If we put them in our repo, it's easy to maintain actually, but will make the pull action slower;

if we put them in the CDN, we need to upload them when updating the images, but will speedup the pull action.

Both are ok to me, how about others' opinion?

☺️ #OpenSourceIsLove

Hii all, want to add something. We could also go for git lfs (faster pull). The CDN approach is okay until we need to update those static files in future releases where pinpointing the content through its CDN URL will be a huge pain in the neck. On the other hand, relative links .... (you know, just update the static file, that's it, hehe) :)

but don't you think we should only go for that if we are handling large files?

Haha, there is no exact threshold to consider what is a large file, isn't it!! Just said about another available option with better docs management (IMO) :)

I agree 😊

imjoey

/lgtm

Thank you @iamayushdas .

liuxiran

LGTM, thanks a lot

do we need to update docs about how to upload images when someone, like me not familiar with Github CDN, wants to update the images in the user_guide? @juzhiyuan

juzhiyuan · 2021-04-05T01:28:12Z

oad images w

ya, we could move this part to our website :)

juzhiyuan · 2021-04-05T01:28:24Z

Anyone would like to crate an issue to track this?

iamayushdas · 2021-04-05T02:46:14Z

Anyone would like to crate an issue to track this?

ya sure!

iamayushdas · 2021-04-05T02:52:02Z

@juzhiyuan there is a problem i guess.
our website is breaking, is this because of CDN, Because it didn't happened before

See:
https://apisix.apache.org/docs/dashboard/USER_GUIDE/

here in docs its perfectly ok
https://github.com/apache/apisix-dashboard/blob/master/docs/en/latest/USER_GUIDE.md#dashboard

juzhiyuan · 2021-04-05T06:59:17Z

alive now, that's due to we need to rebuild our website./

1502shivam-singh · 2021-04-05T21:34:38Z

LGTM, thanks a lot

do we need to update docs about how to upload images when someone, like me not familiar with Github CDN, wants to update the images in the user_guide? @juzhiyuan

While editing the .md files on GitHub, dragging and dropping the image in should do the work :)

iamayushdas added 8 commits March 26, 2021 12:10

feat: improved plugin #1631

4dbe90e

docs: tells users where they are

44d48bb

docs: tells users where they are

8f5c85b

docs: tells users where they are

dcb3d61

docs: tells users where they are

e6793d6

Merge branch 'sidebar' of github.com:iamayushdas/apisix-dashboard int…

7cfe580

…o sidebar

docs: tells users where they are

1b5c270

docs: update the image in the USER_GUIDE.md

f3f595b

iamayushdas changed the title ~~Docs~~ docs: update the image in the USER_GUIDE.md #1683 Mar 30, 2021

juzhiyuan requested review from nic-chen and starsz March 30, 2021 07:05

Merge branch 'master' into docs

5b5621c

juzhiyuan reviewed Apr 3, 2021

View reviewed changes

docs/en/latest/USER_GUIDE.md Show resolved Hide resolved

iamayushdas commented Apr 3, 2021

View reviewed changes

docs/en/latest/USER_GUIDE.md Show resolved Hide resolved

juzhiyuan reviewed Apr 4, 2021

View reviewed changes

juzhiyuan approved these changes Apr 4, 2021

View reviewed changes

juzhiyuan requested review from imjoey and liuxiran April 4, 2021 00:12

imjoey reviewed Apr 4, 2021

View reviewed changes

imjoey approved these changes Apr 4, 2021

View reviewed changes

juzhiyuan requested a review from LiteSun April 4, 2021 07:18

liuxiran approved these changes Apr 4, 2021

View reviewed changes

nic-chen approved these changes Apr 5, 2021

View reviewed changes

juzhiyuan merged commit 8494e45 into apache:master Apr 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update the image in the USER_GUIDE.md #1683 #1689

docs: update the image in the USER_GUIDE.md #1683 #1689

iamayushdas commented Mar 30, 2021

codecov-io commented Mar 30, 2021

iamayushdas commented Mar 30, 2021 •

edited

Loading

juzhiyuan commented Mar 30, 2021

bisakhmondal commented Mar 30, 2021

iamayushdas commented Mar 30, 2021

iamayushdas commented Mar 30, 2021

juzhiyuan commented Mar 30, 2021

nic-chen commented Mar 31, 2021

iamayushdas commented Mar 31, 2021

juzhiyuan commented Mar 31, 2021

iamayushdas commented Apr 1, 2021

starsz commented Apr 2, 2021

iamayushdas commented Apr 2, 2021

iamayushdas commented Apr 3, 2021

juzhiyuan Apr 4, 2021

imjoey Apr 4, 2021

juzhiyuan Apr 4, 2021

imjoey Apr 4, 2021

iamayushdas Apr 4, 2021

juzhiyuan Apr 4, 2021

iamayushdas Apr 4, 2021

bisakhmondal Apr 4, 2021

iamayushdas Apr 4, 2021

bisakhmondal Apr 4, 2021

iamayushdas Apr 4, 2021

imjoey left a comment

liuxiran left a comment

juzhiyuan commented Apr 5, 2021

juzhiyuan commented Apr 5, 2021

iamayushdas commented Apr 5, 2021

iamayushdas commented Apr 5, 2021 •

edited

Loading

juzhiyuan commented Apr 5, 2021

1502shivam-singh commented Apr 5, 2021

docs: update the image in the USER_GUIDE.md #1683 #1689

docs: update the image in the USER_GUIDE.md #1683 #1689

Conversation

iamayushdas commented Mar 30, 2021

codecov-io commented Mar 30, 2021

Codecov Report

iamayushdas commented Mar 30, 2021 • edited Loading

juzhiyuan commented Mar 30, 2021

bisakhmondal commented Mar 30, 2021

iamayushdas commented Mar 30, 2021

iamayushdas commented Mar 30, 2021

juzhiyuan commented Mar 30, 2021

nic-chen commented Mar 31, 2021

iamayushdas commented Mar 31, 2021

juzhiyuan commented Mar 31, 2021

iamayushdas commented Apr 1, 2021

starsz commented Apr 2, 2021

iamayushdas commented Apr 2, 2021

iamayushdas commented Apr 3, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

imjoey left a comment

Choose a reason for hiding this comment

liuxiran left a comment

Choose a reason for hiding this comment

juzhiyuan commented Apr 5, 2021

juzhiyuan commented Apr 5, 2021

iamayushdas commented Apr 5, 2021

iamayushdas commented Apr 5, 2021 • edited Loading

juzhiyuan commented Apr 5, 2021

1502shivam-singh commented Apr 5, 2021

iamayushdas commented Mar 30, 2021 •

edited

Loading

iamayushdas commented Apr 5, 2021 •

edited

Loading