apisix-website
apisix-website copied to clipboard
apache
discuss: a new structure of Apache APISIX website
Actual Behaviour
I found that Apache APISIX website is not very convenient, I often can't find the content that I want. But after browsing many times, I found Apache APISIX website is very informative.
I've also followed Apache APISIX other media and found a lot of really great content that isn't posted on the website.
I have listed some of the problems on the website：
-
Apache APISIX website modules are not clear, e.g.
- Homepage: The introduction of Apache APISIX on the homepage is not complete. The full features are on the Github readme.
- Events: Events module does not have a dedicated tab on the nav. There are only 4 information introductions are displayed on the homepage, which is hard to be noticed. The content on the events page is not categorized.
- Blog: Blog show too little information, and the style is simple.
- Docs: The document structure is deep and hard to find.
- Language: There are two languages on the website, but the English and Chinese contents are mixed together.
- There is no content under the existing modules, such as news
-
Lack of linking channels to contributors
- Except for good first issues ，for potential and new contributors (like me), I don't know what can I contribute.
- Contact information is hidden too deep, it is in the second level under the tab. Or I change to Apache APISIX Github to find contact information.
-
Apache APISIX has a lot of learning materials and information, but the website is not the most comprehensive.
I think a useful contributor site is the first step to attract contributors. What do you think？
Expected Behaviour
Based on the above problems, I came up with a solution to make Apache APISIX website better and easier to find learning materials, and I hope more and more people will participate in contributing to Apache APISIX. I have drawn a prototype of the website, please take a look.
This is homepage. Show Apache APISIX features, events, and ways to join the community on the homepage.
This is learning page. There are a lot of Apache APISIX learning materials, e.g. blogs, videos, user cases ……
This is Event page. About the event page, I posted an issue a month ago.
This is Contribute page. Show a lot of ways to contribute content, like translating blog, posting videos, recieving good first issues.
Hi @Serendipity96, Appreciate your work on highlighting the problems. We are aware of most (if not all) issues that you have highlighted here and are working in a stepwise manner to solve this bigger problem by solving the smaller sub problems.
As of completed checkpoints, I personally have worked out the homepage redesign and code and the plugin hub page design (wireframe only). The new homepage is in discussion to be merged, check it out at apisix-redesign this solves all the issues that you mentioned for the home page while being asthetically pleasing.
Currently we are working on improving the blog section of apisix-website, making it along the lines of the design of the homepage for uniformity throughout.
We will try our best to accomodate all your suggestions/recommendations along the way 😊.
hi @1502shivam-singh, Wow, the new version of the Apache APISIX homepage is so cool. The introduction of Apache APISIX has become rich and the homepage style is fashion. I know my question is too much and there are still a lot of details to discuss. You mentioned that the blog page is being revamped, can you introduce more information? Can I join the discussion?
I know my question is too much and there are still a lot of details to discuss.
Not really, actually you are asking and raising the right issues that weren't raised way earlier. Happy that more people are expressing these problems and raising issues :)
You mentioned that the blog page is being revamped, can you introduce more information? Can I join the discussion?
Sure ! You can start from #490 to track the discussion and follow along.
@1502shivam-singh , thank you very much for your encouragement. It's really a pleasure to discuss in the community. I believe Apache APISIX website will get better and better.
I have read all these discussions, you have done careful research. I think I can add some new article tags and sort them by new tags.
I have designed a plan for the blog issue raised above. First, let me briefly describe my plan: I have divided APISIX related material into two categories, one is blog and the other is video. Blogs and videos will be added tags, so that everyone can easily find the information according to his or her needs.
APISIX related materials are divided into two categories, one is articles and the other is videos.
description:
Click on the navigation bar blog to enter the page. By default, select [Articles] category.
Click the [Article] [Video] tab to switch to the corresponding page.
1.1 Article List Page
Classification
| Classification | Description |
|---|---|
| Latest | The time sequence is reversed, the latest published articles are placed at the top, and all articles are listed. |
| Tech | Technical solution, implementation principle, source code interpretation, architecture design type articles |
| User Case | User case |
| Best Practices | Collaboration with other communities/technologies to run APISIX on other platforms, eg: Rancher × APISIX, |
| Weekly Report | Community weekly report |
| Events | Event previews migrated from the Events page |
| Release | APISIX release, feature articles, and release logs |
| Easy | Easy article |
| Medium | Medium article |
| Hard | Hard Articles |
Article Introduction
The article introduction includes:
- Title
- Author name
- Article introduction
- tags
- Release time, reading time
To sum up, the content is not much different from the following screenshots, mainly add the cover picture.
The purpose of adding a cover image:
- Display corporate case logo
- Improve the aesthetics of the article list page
Pagination
Add a pagination button at the bottom of the article list.
Label
description:
Click on a tag, the page will select the "latest" category by default, and display the articles under the tag, and the paging button will be displayed at the bottom.
Tag only supports selecting one at a time.
Example 1: In the user case, select Ingress and take the intersection of the two.
Example 2: Under Weekly Report, select Ingress, no releated content, so show the content of the article classification first, that is, the Weekly Report list.
1.2 Article Details Page
No modified features.
- Keep the previous and subsequent article recommendation buttons at the bottom.
- Keep the bottom Tags to click and jump to the corresponding category.
- Still keep the latest release on the left as a recommendation.
2.1 Video List Page
Classification
| Classification | Description |
|---|---|
| Latest | The time sequence is reversed, the latest published articles are placed at the top, and all articles are listed. |
| Tech | Technical solution, implementation principle, source code interpretation, architecture design type videos |
| User Case | user case |
| Best Practices | Collaboration with other communities/technologies to run APISIX on other platforms, eg: Rancher × APISIX, |
| Events | Like ApacheCon |
| Release | APISIX release, function introduction videos |
| Easy | Easy videos |
| Medium | Medium videos |
| Hard | Hard videos |
Video Introduction
- Video Cover
- Video duration
- Title
- Release time Example:
Pagination
2.2 Video Details Page
Classification
- Video Title
- Video release date
- Video tag
3.1 Search
After adding the video, can the search bar find the video and support jumping?
@juzhiyuan @1502shivam-singh @yzeng25 What do you think? Looking forward to your feedback, thanks.
Woh, a really detailed document. Maybe store it all as a markdown file, so that it doesn't get lost in the comments and can be referred later.
One question though, what exactly would be in the videos tab ? Can we adjust videos in related articles, like attaching the ApacheCon video in the ApacheCon articles for instance. What I am trying to emphasize here, is maybe let the majority of video content on respective platform (YouTube, Vimeo, etc.) to provide the brand of Apache APISIX some traction in that area.
Some few videos on main website and specific ones in articles, acting as a funnel to the APISIX's Youtube channel (or channel on another platform)
What you all feel on this ?
Yeah, store the content as a markdown file is a good suggestion. Where should the markdown be placed? Do you have a good suggestion?
I want to make a collection of Apache APISIX related videos, so that everyone can see the most complete Apache APISIX material on the website, instead of finding it elsewhere. Some of the videos do not have corresponding articles, but they are good sources for learning and understanding Apache APISIX.
Yeah, store the content as a markdown file is a good suggestion. Where should the markdown be placed? Do you have a good suggestion?
Not really sure on this, maybe others can chime in and suggest. For now, atleast keep one with you. I usually like trello boards or similar to track plans like this, like a board with checkpoints and links with reference to plans. Really, depends on your workflow.
I want to make a collection of Apache APISIX related videos, so that everyone can see the most complete Apache APISIX material on the website, instead of finding it elsewhere. Some of the videos do not have corresponding articles, but they are good sources for learning and understanding Apache APISIX.
Okay, understood. Like a video collection at one place.
Not really sure on this, maybe others can chime in and suggest. For now, atleast keep one with you. I usually like trello boards or similar to track plans like this, like a board with checkpoints and links with reference to plans. Really, depends on your workflow.
Thanks, let me see.
Hi @juzhiyuan , How is it going？
Do you need some help? I‘m not familiar with React, but I've coded some projects using Vue. Maybe I can finish some features.
If you assign some features to me, I think we should discuss the technical solutions together.
If I finish the function, how can I test using related backend data?
confirmed with @Serendipity96, she will continue to resolve those issues when she has time.
hi @juzhiyuan @1502shivam-singh, I finished the development of the first part of Contribute Page. please take a look here.
@juzhiyuan @Serendipity96 @guoqqqi
It seems like there's a lot that's been done here, and a lot that hasn't been done or needs to be done. But this issue has been around for so long that many of the descriptions no longer fit the current scenario, so maybe we can close this issue and discuss the site's structure in a new issue.
