apisix-website Site Usability: Apisix versions are easy mistaken

Current State

Description of the current state/issue:

I like the modern design system of our website.

I think there's an issue with our web usability: the version block and the component one are too far from each other.

web-issue

Users may mistakenly think this is the version of apisix instead.

Link to the page:

Any doc page, for example: https://apisix.apache.org/docs/apisix/getting-started/

Desired State

Description of the change you are proposing:

We can move the component-selector block to the sidebar at the top-right corner

Would you like to fix this issue?

No. Please assign another contributor

Jan 09 '23 15:01 anhldbk

We are preparing to modify this part. I have had no time recently, but I will help to modify this part as soon as possible.

@juzhiyuan @guoqqqi Maybe you have time to help improve this?

Jan 10 '23 07:01 SkyeYoung

No, there have a lot of TODOs... Just added good first issue

Jan 11 '23 06:01 juzhiyuan

I would like to work on this issue

Jan 25 '23 11:01 RajVarsani

@RajVarsani 😸 Great! If there are any problems, please feel free to @ any of us. (Hope you won't be dissuaded by the old ugly code. 🥲)

Jan 25 '23 11:01 SkyeYoung

Sure I'll start with setup then, will update here if I encounter any issue.

Jan 25 '23 11:01 RajVarsani

@SkyeYoung Can we use the same versions for sub components?

Jan 29 '23 08:01 anhldbk

@anhldbk Could you please give me an example? I'm not sure if I'm thinking what you're talking about. 🤔

Jan 29 '23 09:01 SkyeYoung

@SkyeYoung AFAIK Apisix comprises of various sub components with differrent versions in releases. Multiple versions lead to this issue and other compatibility issues like this one.

My question is: can we use the same version for each component? Vertx uses this approach.

Jan 30 '23 05:01 anhldbk

@SkyeYoung, I set up the codebase in my locally. I have encountered a couple of issues. I opened it in the Dev container, and it shows 624 (Which is the total number of files in the repo ig) file changes because of End of Line Difference (I'm in windows).

I'm using this command: yarn start:doc . How do I see changes reflected in the server? I tried changing the content of the nav links, but it is not reflecting as hot or even hard reload. I had need to restart the server to see the changes

Jan 30 '23 13:01 RajVarsani

@RajVarsani

For the end-of-line symbol problem, I think you can fix it by clicking Ctrl + Shift + P and typing Change End of Line Sequence and selecting LF.

For the question about hot reloading, it's not really supposed to have this problem ... I need to try it out. But I don't use Windows directly for any development work, including installing docker-desktop on it, so it will take a bit of time and I may be able to tell you tomorrow

Jan 30 '23 14:01 SkyeYoung

Update: I've discarded all previous changes and updated vs code prefs, so the LF-CRLF issue seems to be resolved. Thanks, @SkyeYoung, Lmk if you find any update on the reloading issue.

Jan 30 '23 14:01 RajVarsani

@SkyeYoung AFAIK Apisix comprises of various sub components with differrent versions in releases. Multiple versions lead to this issue and other compatibility issues like this one.

My question is: can we use the same version for each component? Vertx uses this approach.

🤔 cc @juzhiyuan

Jan 31 '23 03:01 SkyeYoung

There has no plan to release packages with the same version numbers. But I suggest adding some notes on each project's documentation: which version is compatible?

A better way is let each component to auto detect version 🤔

Feb 01 '23 00:02 juzhiyuan

Update: I've discarded all previous changes and updated vs code prefs, so the LF-CRLF issue seems to be resolved. Thanks, @SkyeYoung, Lmk if you find any update on the reloading issue.

@RajVarsani Sorry for too late. I tried it, but it doesn't seem to reproduce the thermal reloading problem. I tried searching and found this https://stackoverflow.com/questions/65445600/hot-reload-is-not-working-in-my-react-app. I don't know if it will help you...

Feb 01 '23 10:02 SkyeYoung

I'll check and update here ✅

Feb 01 '23 15:02 RajVarsani

@SkyeYoung @anhldbk Hello, can I work on this issue?

Apr 26 '23 11:04 Mackenzie-OO7

Hey, I'm new to open source and would like to work on this so can you please assign me this issue.

Apr 26 '23 17:04 kondapalli19

@Mackenzie-OO7 @kondapalli19 Hi, I think you can try to collaborate and work together to complete it. Alternatively, you can try dividing the work among yourselves and each person can complete their own part. This will require you to collaborate and communicate with each other. 😸

Apr 27 '23 00:04 SkyeYoung

@SkyeYoung T component-selector block you want to put that at the top of the version selector block or something else

Apr 28 '23 16:04 kondapalli19

@Mackenzie-OO7 Hi! Thank you for the suggestions. I think dividing the work among ourselves and communicating with each other would be a good approach. Let's discuss how we can divide the work and make sure we're on the same page. Looking forward to working together on this! 😊

Apr 28 '23 16:04 kondapalli19

Hey @anhldbk, is this still available?