You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/10/13 02:30:37 UTC
[GitHub] [apisix-website] Serendipity96 opened a new issue #607: discuss: a new structure of Apache APISIX website
Serendipity96 opened a new issue #607:
URL: https://github.com/apache/apisix-website/issues/607
**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](https://github.com/apache/apisix).
* 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](https://github.com/apache/apisix-website/issues/473) a month ago.**
**This is Contribute page. Show a lot of ways to contribute content, like translating blog, posting videos, recieving good first issues.**
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Serendipity96 commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
Serendipity96 commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-974637119
hi @juzhiyuan @1502shivam-singh, I finished the development of the first part of Contribute Page. please take a look [here](
https://github.com/apache/apisix-website/pull/758).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] 1502shivam-singh commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
1502shivam-singh commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-920918423
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](https://apisix-re.netlify.app/) 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 😊.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Serendipity96 commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
Serendipity96 commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-941861852
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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] juzhiyuan commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-968293474
confirmed with @Serendipity96, she will continue to resolve those issues when she has time.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Serendipity96 commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
Serendipity96 commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-950955019
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?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] 1502shivam-singh commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
1502shivam-singh commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-941020999
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 ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Serendipity96 commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
Serendipity96 commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-941861852
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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Serendipity96 commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
Serendipity96 commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-974637119
hi @juzhiyuan @1502shivam-singh, I finished the development of the first part of Contribute Page. please take a look [here](
https://github.com/apache/apisix-website/pull/758).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] 1502shivam-singh commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
1502shivam-singh commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-921762682
> 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Serendipity96 closed issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
Serendipity96 closed issue #607:
URL: https://github.com/apache/apisix-website/issues/607
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Serendipity96 commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
Serendipity96 commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-922235391
@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](https://github.com/apache/apisix-website/issues/490), you have done careful research. I think I can add some new article tags and sort them by new tags.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Serendipity96 commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
Serendipity96 commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-921428979
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?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Serendipity96 closed issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
Serendipity96 closed issue #607:
URL: https://github.com/apache/apisix-website/issues/607
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Serendipity96 commented on issue #607: discuss: a new structure of Apache APISIX website
Posted by GitBox <gi...@apache.org>.
Serendipity96 commented on issue #607:
URL: https://github.com/apache/apisix-website/issues/607#issuecomment-940645230
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.
<div data-zone-id="0" data-line-index="0" style="white-space: pre;"><h2 class="heading-h2">1.1 Article List Page
</h2></div><div data-zone-id="0" data-line-index="1" style="white-space: pre;"><h3 class="heading-h3">Classification
</h3></div><div data-zone-id="0" data-line-index="2" style="white-space: pre;">Under the article tab, perform secondary classification. The following are all classifications:
</div><div data-zone-id="0" data-line-index="3" style="white-space: pre;">
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
</div>
<div data-zone-id="0" data-line-index="0" style="white-space: pre;"><h2>
</h2></div><div data-zone-id="0" data-line-index="1" style="white-space: pre;"><h3 class="heading-h3">Article Introduction
</h3></div><div data-zone-id="0" data-line-index="2" style="white-space: pre;">
</div><div data-zone-id="0" data-line-index="3" style="white-space: pre;">
</div>
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
<div data-zone-id="0" data-line-index="0" style="white-space: pre;"><h2>
</h2></div><div data-zone-id="0" data-line-index="1" style="white-space: pre;"><h3 class="heading-h3">Pagination
</h3></div><div data-zone-id="0" data-line-index="2" style="white-space: pre;">
</div><div data-zone-id="0" data-line-index="3" style="white-space: pre;">
</div>
Add a pagination button at the bottom of the article list.
<div data-zone-id="0" data-line-index="0" style="white-space: pre;"><h2>
</h2></div><div data-zone-id="0" data-line-index="1" style="white-space: pre;"><h3 class="heading-h3">Label
</h3></div><div data-zone-id="0" data-line-index="2" style="white-space: pre;">
</div><div data-zone-id="0" data-line-index="3" style="white-space: pre;">
</div>
Remove recent posts and change to tags collection Article tag collection.
**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.
<div data-zone-id="0" data-line-index="0" style="white-space: pre;"><h2 class="heading-h2">1.2 Article Details Page
</h2></div><div data-zone-id="0" data-line-index="1" style="white-space: pre;"><h3 class="heading-h3">
</h3></div><div data-zone-id="0" data-line-index="2" style="white-space: pre;">
</div><div data-zone-id="0" data-line-index="3" style="white-space: pre;">
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.
<div data-zone-id="0" data-line-index="0" style="white-space: pre;"><h2 class="heading-h2">2.1 Video List Page
</h2></div><div data-zone-id="0" data-line-index="1" style="white-space: pre;">Existing videos on youtube site, on twitter, ApacheCon video on API7 website.
</div><div data-zone-id="0" data-line-index="2" style="white-space: pre;"><h3 class="heading-h3">Classification
</h3></div><div data-zone-id="0" data-line-index="3" style="white-space: pre;">
</div>
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
<div data-zone-id="0" data-line-index="0" style="white-space: pre;"><h2>
</h2></div><div data-zone-id="0" data-line-index="1" style="white-space: pre;"><h3 class="heading-h3">Video Introduction
</h3></div><div data-zone-id="0" data-line-index="2" style="white-space: pre;">
</div><div data-zone-id="0" data-line-index="3" style="white-space: pre;">
</div>
- Video Cover
- Video duration
- Title
- Release time
Example:
<div data-zone-id="0" data-line-index="0" style="white-space: pre;"><h2>
</h2></div><div data-zone-id="0" data-line-index="1" style="white-space: pre;"><h3 class="heading-h3">Pagination
</h3></div><div data-zone-id="0" data-line-index="2" style="white-space: pre;">
</div><div data-zone-id="0" data-line-index="3" style="white-space: pre;">
</div>
Pagination
Add a pagination button at the bottom of the video list.
<div data-zone-id="0" data-line-index="0" style="white-space: pre;"><h2 class="heading-h2">2.2 Video Details Page
</h2></div><div data-zone-id="0" data-line-index="1" style="white-space: pre;">
</div><div data-zone-id="0" data-line-index="2" style="white-space: pre;"><h3 class="heading-h3">Classification
</h3></div><div data-zone-id="0" data-line-index="3" style="white-space: pre;">
</div>
- Video Title
- Video release date
- Video tag
<div data-zone-id="0" data-line-index="0" style="white-space: pre;"><h2 class="heading-h2">3.1 Search
</h2></div><div data-zone-id="0" data-line-index="1" style="white-space: pre;">
</div><div data-zone-id="0" data-line-index="2" style="white-space: pre;"><h3 class="heading-h3">
</h3></div><div data-zone-id="0" data-line-index="3" style="white-space: pre;">
</div>
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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org