feat: use k8s.website.tabs to show different installation types #3139

yuluo-yx · 2024-04-09T03:43:02Z

For docs: use tabs in Quickstart #3131

before:

after:

show:

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

site/content/en/v1.0.0/user/quickstart.md

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

codecov · 2024-04-09T03:57:36Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.53%. Comparing base (29946b0) to head (a53f6e0).
Report is 52 commits behind head on main.

❗ Current head a53f6e0 differs from pull request most recent head 5395ff6. Consider uploading reports for the commit 5395ff6 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3139      +/-   ##
==========================================
+ Coverage   66.51%   66.53%   +0.02%     
==========================================
  Files         161      161              
  Lines       22673    22693      +20     
==========================================
+ Hits        15080    15098      +18     
- Misses       6720     6722       +2     
  Partials      873      873

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

site/content/en/latest/user/quickstart.md

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

site/content/en/latest/user/quickstart.md

arkodg · 2024-04-09T04:15:41Z

site/content/en/latest/user/quickstart.md

@@ -47,10 +47,16 @@ consideration when debugging.

 ## Testing the Configuration

+{{< tabs name="tabs_test_the_configuration" >}}


imo we need to flip this

With External LoadBalancer Support

Without External LoadBalancer Support

cc @eitansuez

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

site/content/en/latest/user/quickstart.md

arkodg · 2024-04-09T04:18:56Z

site/content/en/latest/user/quickstart.md

+export ENVOY_SERVICE= \ 
+    $(kubectl get svc -n envoy-gateway-system \
+    --selector=gateway.envoyproxy.io/owning-gateway-namespace=default,gateway.envoyproxy.io/owning-gateway-name=eg \
+    -o jsonpath='{.items[0].metadata.name}')


even the curl needs to be part of the tab because its using different ports

arkodg · 2024-04-09T04:19:54Z

thanks @yuluo-yx, added some comments !

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

yuluo-yx · 2024-04-09T09:45:56Z

/retest

eitansuez · 2024-04-09T16:58:18Z

if i'm not mistaken this pr will not only apply tabs to the quickstart, but more generally enable the use of tabs in the documentation. once it's merged i'll work on using this feature in additional contexts.

yuluo-yx · 2024-04-10T02:11:47Z

if i'm not mistaken this pr will not only apply tabs to the quickstart, but more generally enable the use of tabs in the documentation. once it's merged i'll work on using this feature in additional contexts.

yep, This is mentioned in #3133.

eitansuez · 2024-04-10T17:04:41Z

i just checked out this PR, the tabs render correctly, but the functionality (switching between tabs) doesn't appear to work: clicking on the currently-selected tab has this undesirable scroll effect, while clicking on the other tab (to switch to it) does nothing. has anyone else tried it and gotten it to work?

yuluo-yx · 2024-04-11T02:12:30Z

i just checked out this PR, the tabs render correctly, but the functionality (switching between tabs) doesn't appear to work: clicking on the currently-selected tab has this undesirable scroll effect, while clicking on the other tab (to switch to it) does nothing. has anyone else tried it and gotten it to work?

my bad, let me check

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

yuluo-yx · 2024-04-11T05:12:00Z

i just checked out this PR, the tabs render correctly, but the functionality (switching between tabs) doesn't appear to work: clicking on the currently-selected tab has this undesirable scroll effect, while clicking on the other tab (to switch to it) does nothing. has anyone else tried it and gotten it to work?

hi, @eitansuez . I fixed , pls review again. tks 🫡

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

yuluo-yx · 2024-04-11T06:19:04Z

/retest

eitansuez · 2024-04-11T15:56:21Z

Hi @yuluo-yx it works now. thanks for the quick fix.

separately, i agree with @arkodg 's comment about making the "with loadbalancer support" tab the left/default tab. so.. could you please switch the order of the tabs?

otherwise it looks good to me.

yuluo-yx · 2024-04-12T02:06:50Z

Hi @yuluo-yx it works now. thanks for the quick fix.

separately, i agree with @arkodg 's comment about making the "with loadbalancer support" tab the left/default tab. so.. could you please switch the order of the tabs?

otherwise it looks good to me.

Is that right? I'm not sure I understand what you're saying. 🥲🥲

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

site/content/en/latest/tasks/quickstart.md

arkodg · 2024-04-12T05:32:51Z

site/static/js/dismiss_banner.js

@@ -0,0 +1,41 @@
+$(document).ready(function() {


why do we need this

I think https://www.docsy.dev/docs/adding-content/shortcodes/#tabbed-panes is enough or what I missed?

why do we need this

Without these js files, the tab switching action may not be possible, I have streamlined the files.

I think https://www.docsy.dev/docs/adding-content/shortcodes/#tabbed-panes is enough or what I missed?

I referenced the k8s website as mentioned in #3131

can we only add what's required to create tabs e.g. https://learn.netlify.app/en/shortcodes/tabs/
we dont need to copy the k8s theme
I linked k8s as an example to show how tabs were being used in other projects

can we only add what's required to create tabs e.g. https://learn.netlify.app/en/shortcodes/tabs/ we dont need to copy the k8s theme I linked k8s as an example to show how tabs were being used in other projects

yep, I understand that if I delete these js files locally, the toggle between tabs will not work, so I added these CSS and js files to achieve the toggle effect and did not copy the k8s theme file.

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

eitansuez · 2024-04-12T19:56:10Z

Is that right? I'm not sure I understand what you're saying. 🥲🥲

yes, that's right. sorry for the late reply.

yuluo-yx · 2024-04-13T07:22:36Z

/retest

yuluo-yx · 2024-04-13T07:24:10Z

Is there another implementation of this feat or are there any other problems with it, if there is an alternative I can close.
@arkodg @eitansuez

arkodg · 2024-04-15T16:06:25Z

Hey @yuluo-yx, can you please rebase, we can merge post that

Signed-off-by: YuLuo <yuluo08290126@gmail.com>

zirain · 2024-04-16T12:03:24Z

this PR is far away than my expected, PTAL #3208

zirain · 2024-04-16T12:04:36Z

maybe you can rebase your work base on #3208 ?

yuluo-yx · 2024-04-17T02:34:04Z

It is merged, I will close it.

zirain · 2024-04-17T02:52:17Z

It is merged, I will close it.

you can rebase with main branch, you did a lot of around better display/html/css, those are very valuable.

yuluo-yx · 2024-04-17T04:27:27Z

It is merged, I will close it.

you can rebase with main branch, you did a lot of around better display/html/css, those are very valuable.

current pr is too confusing, I will resubmit a pr to update the existing file style, thank you for recognizing my work! 🫡

feat: use k8s.website.tabs to show different installation types

3508bd3

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

yuluo-yx requested a review from a team as a code owner April 9, 2024 03:43

zirain reviewed Apr 9, 2024

View reviewed changes

site/content/en/v1.0.0/user/quickstart.md Outdated Show resolved Hide resolved

zirain reviewed Apr 9, 2024

View reviewed changes

site/content/en/v1.0.0/user/quickstart.md Outdated Show resolved Hide resolved

sync: sync to latest

a53f6e0

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

yuluo-yx force-pushed the 0409-yuluo/docs branch from 278a016 to a53f6e0 Compare April 9, 2024 03:52

Merge branch 'main' into 0409-yuluo/docs

ccdf057

shawnh2 reviewed Apr 9, 2024

View reviewed changes

site/content/en/latest/user/quickstart.md Outdated Show resolved Hide resolved

fix: fix typo

0a5e9f3

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

shawnh2 reviewed Apr 9, 2024

View reviewed changes

site/content/en/latest/user/quickstart.md Outdated Show resolved Hide resolved

arkodg reviewed Apr 9, 2024

View reviewed changes

site/content/en/latest/user/quickstart.md Outdated Show resolved Hide resolved

arkodg reviewed Apr 9, 2024

View reviewed changes

fix: fix typo

b5bb85b

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

arkodg reviewed Apr 9, 2024

View reviewed changes

site/content/en/latest/user/quickstart.md Outdated Show resolved Hide resolved

arkodg reviewed Apr 9, 2024

View reviewed changes

yuluo-yx added 3 commits April 9, 2024 16:21

Merge https://github.com/envoyproxy/gateway

afc55eb

fix

9f20889

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

Merge branch 'main' into 0409-yuluo/docs

c431953

shawnh2 mentioned this pull request Apr 9, 2024

docs: Translate quickstart of user guide page into Chinese #3148

Merged

arkodg requested review from Xunzhuo and zirain April 10, 2024 07:06

docs: fix

a692269

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

yuluo-yx added 2 commits April 11, 2024 13:44

fix: fix ci skip js files

06313a7

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

fix

0246dff

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

chore: switch the order tabs

ec382a5

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

arkodg reviewed Apr 12, 2024

View reviewed changes

site/content/en/latest/tasks/quickstart.md Outdated Show resolved Hide resolved

arkodg reviewed Apr 12, 2024

View reviewed changes

yuluo-yx added 3 commits April 12, 2024 14:02

fix

aa9cbb8

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

chore: redundant js files

3e038f8

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>

Merge branch 'main' into 0409-yuluo/docs

6184231

Merge branch 'main' into 0409-yuluo/docs

4dbac2a

arkodg previously approved these changes Apr 15, 2024

View reviewed changes

arkodg requested review from shawnh2 and a team April 15, 2024 15:53

shawnh2 approved these changes Apr 15, 2024

View reviewed changes

Merge branch 'main' into 0409-yuluo/docs

5395ff6

Signed-off-by: YuLuo <yuluo08290126@gmail.com>

yuluo-yx dismissed arkodg’s stale review via 5395ff6 April 16, 2024 11:41

zirain mentioned this pull request Apr 16, 2024

docs: use tabpane #3208

Merged

yuluo-yx closed this Apr 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: use k8s.website.tabs to show different installation types #3139

feat: use k8s.website.tabs to show different installation types #3139

yuluo-yx commented Apr 9, 2024 •

edited

Loading

codecov bot commented Apr 9, 2024 •

edited

Loading

arkodg Apr 9, 2024

arkodg Apr 9, 2024

arkodg commented Apr 9, 2024

yuluo-yx commented Apr 9, 2024

eitansuez commented Apr 9, 2024

yuluo-yx commented Apr 10, 2024

eitansuez commented Apr 10, 2024 •

edited

Loading

yuluo-yx commented Apr 11, 2024

yuluo-yx commented Apr 11, 2024 •

edited

Loading

yuluo-yx commented Apr 11, 2024

eitansuez commented Apr 11, 2024

yuluo-yx commented Apr 12, 2024

arkodg Apr 12, 2024

zirain Apr 12, 2024

yuluo-yx Apr 12, 2024

yuluo-yx Apr 12, 2024

arkodg Apr 12, 2024

yuluo-yx Apr 12, 2024

eitansuez commented Apr 12, 2024

yuluo-yx commented Apr 13, 2024

yuluo-yx commented Apr 13, 2024

arkodg commented Apr 15, 2024

zirain commented Apr 16, 2024

zirain commented Apr 16, 2024

yuluo-yx commented Apr 17, 2024

zirain commented Apr 17, 2024

yuluo-yx commented Apr 17, 2024

		@@ -47,10 +47,16 @@ consideration when debugging.

		## Testing the Configuration

		{{< tabs name="tabs_test_the_configuration" >}}

feat: use k8s.website.tabs to show different installation types #3139

feat: use k8s.website.tabs to show different installation types #3139

Conversation

yuluo-yx commented Apr 9, 2024 • edited Loading

codecov bot commented Apr 9, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arkodg commented Apr 9, 2024

yuluo-yx commented Apr 9, 2024

eitansuez commented Apr 9, 2024

yuluo-yx commented Apr 10, 2024

eitansuez commented Apr 10, 2024 • edited Loading

yuluo-yx commented Apr 11, 2024

yuluo-yx commented Apr 11, 2024 • edited Loading

yuluo-yx commented Apr 11, 2024

eitansuez commented Apr 11, 2024

yuluo-yx commented Apr 12, 2024

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

eitansuez commented Apr 12, 2024

yuluo-yx commented Apr 13, 2024

yuluo-yx commented Apr 13, 2024

arkodg commented Apr 15, 2024

zirain commented Apr 16, 2024

zirain commented Apr 16, 2024

yuluo-yx commented Apr 17, 2024

zirain commented Apr 17, 2024

yuluo-yx commented Apr 17, 2024

yuluo-yx commented Apr 9, 2024 •

edited

Loading

codecov bot commented Apr 9, 2024 •

edited

Loading

eitansuez commented Apr 10, 2024 •

edited

Loading

yuluo-yx commented Apr 11, 2024 •

edited

Loading