Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

discuss: community review of improved apisix-website on copywriting #450

Closed
1502shivam-singh opened this issue Aug 13, 2021 · 8 comments · Fixed by #617
Closed

discuss: community review of improved apisix-website on copywriting #450

1502shivam-singh opened this issue Aug 13, 2021 · 8 comments · Fixed by #617
Assignees
Labels
Milestone

Comments

@1502shivam-singh
Copy link
Member

1502shivam-singh commented Aug 13, 2021

Hi all, just finished up with my GSoC project of improving the apisix-website (Redesign and code), would be happy to receive reviews from you all, specifically on copywriting and minor issues like broken links (if any) etc.

Here is the website - https://apisix-re.netlify.app/
Just to mention, all the interactions and animations (WebGL, CSS) you see on this website are my own, implemented from scratch in code. Clarifying for the sake of copyright issues, if any.

I am open to suggestions/changes in copywriting based on reviews by the community.
Hope you like this new perspective of Apache APISIX :)

cc @juzhiyuan , @Yiyiyimu
(If you are aware of community members that might be free/willing to review please mention them, posting here as last time I posted on mailing-list it good mixed and lost with the other mails)

EDIT : For easier review of copywriting check out this PR - #477

@liuxiran
Copy link
Contributor

@1502shivam-singh your redesign of our website is really cool~what particularly attracted me was the middle section of the product description and Learn from developers parts.
image

and it would be better to adjust the layout of the first screen or enrich the content
image

together with the last part of the page: Be a part of building APISIX
image

@1502shivam-singh
Copy link
Member Author

Thanks @liuxiran for the review.
Though I see some irregularities between the actual site and the shots you have provided. For instance -
A shot of the top section -

Hero

Here that flow infographic on the right animates going down, with an interaction that a little bump follows the movement of the
mouse when hovered over that canvas.
The flow infographic in your shot appears almost non existent or blurred out 😕

GitHub invite section -

github

The sphere rotates and is actually interactable by mouse, you can rotate it with mouse drags. I see some misalignments in your shot in this one.

Also something I noticed -
The curved line svg appears behind APISIX's design and animates with color changes, but in your shot it appears down behind "Why APISIX".
arch

Now for providing some perspective here, I have tried keeping a minimalistic and clean design here, given the seriousness of the product APISIX.
The flow in top section is more of a metphor to the smooth, frictionless and synchronised performance of APISIX. It's a subtle element that I came up with after alot of brainstorming on what to put there, and this made most sense to me.

Please match-up if same layout is visible to you too and whether animations and interactions are functioning or not.
Also, if you have time, could you review the text-content of the website. so as to not supply any wrong information to the viewer (I have checked myself, but more eyes are always better 😊)

@1502shivam-singh
Copy link
Member Author

1502shivam-singh commented Aug 16, 2021

Might be an overkill 😅, but please bear with me on this, could you check out this recorded video of the site for matching up layout and interactions

recorded-site.mp4

@Yiyiyimu
Copy link
Member

Nice design @1502shivam-singh! Do you mind creating a markdown version of all the text in the new design and create a not-merge PR for it. I think the text part review could be easier with that.

Some suggestions from my preference 🤣

  1. the right part of the architecture graph seems a little unbalanced, since the all contents are in the upper part. Also we might could change APISIX has dynamic routing and plug-in hot loading to APISIX has dynamic routing and hot-loading plugins to keep the "adj.-n." format
    image
  2. Seem missing a period here: "It’s opensource and ever evolving(.) feel free to contribute". And also we need a screenshot of dashboard in higher resolution
    image
  3. The graph of User Flexible seems not correct. The description of it seems related to low code (the graph used in "Pluginised workflow").
  4. the description here is not so correct. The high performance should come from radixtree-route-matching and also etcd, not from plugins. Also, built-in plugins and json schema is more related to convenience so apisix could be used out-of-box.
    image
  5. maybe we could have a button for the check us out or people might not regard it as clickable
    image

@1502shivam-singh
Copy link
Member Author

Nice design @1502shivam-singh! Do you mind creating a markdown version of all the text in the new design and create a not-merge PR for it. I think the text part review could be easier with that.

Woh, really nice suggestion, you would then be able to provide changes in a better way using github UI. Excellent idea, on it. Also to avoid fiasco with the actual apisix-website repo, I would make a PR on my own repo, and will share link here.

  1. the right part of the architecture graph seems a little unbalanced, since the all contents are in the upper part. Also we might could change APISIX has dynamic routing and plug-in hot loading to APISIX has dynamic routing and hot-loading plugins to keep the "adj.-n." format

Okay, i guess pulling the etcd cluster little bit down to align with bottom edge APISIX block should do. Agreed with the latter.

  1. Seem missing a period here: "It’s opensource and ever evolving(.) feel free to contribute". And also we need a screenshot of dashboard in higher resolution

Noted. I would say a comma maybe, but yeah i got you. On the screenshot, yeah on it, I guess compression did hurt it too much.

  1. The graph of User Flexible seems not correct. The description of it seems related to low code (the graph used in "Pluginised workflow").

Hmm, i was actually referencing the dual ability of code and drag and drop of APISIX. You are right, this one actually needs copywriting changes, like to - The APISIX dashboard is flexible to the user demand, providing option to write code to create custom modules as per your needs, alongside the existing no-code toolchain

  1. the description here is not so correct. The high performance should come from radixtree-route-matching and also etcd, not from plugins. Also, built-in plugins and json schema is more related to convenience so apisix could be used out-of-box.

The perspective I needed, thanks. Okay, need to modify this one. How about - Apache APISIX uses radixtree-route-matching and etcd under the hood to provide you the ability to create high speed synchronized systems. From routing to built-in plugins, all these are designed and implemented to be uber performant with the minimum latency possible.

  1. maybe we could have a button for the check us out or people might not regard it as clickable

Oops missed this. Earlier I thought of a red link as usually seen elsewhere, but yeah a button seems more viable

Thanks for the detailed review, will share PR link here.

@1502shivam-singh
Copy link
Member Author

Check out this PR if you want to review the copywriting - 1502shivam-singh/apisix-website-redesign#11

@Yiyiyimu
Copy link
Member

I believe the copywriting changing all looks good to me!

Besides, maybe you could move the PR here in this repo so more people could notice that

@1502shivam-singh
Copy link
Member Author

Besides, maybe you could move the PR here in this repo so more people could notice that

Done, checkout #477

@juzhiyuan juzhiyuan added this to the V2.1 milestone Oct 4, 2021
SkyeYoung pushed a commit to SkyeYoung/apisix-website that referenced this issue Mar 3, 2022
* feat: add publish status to route in manager api

* fix: update publish and offline route

* feat: add route publish test module

* fix: synchronize content for route publish/offline
SkyeYoung pushed a commit to SkyeYoung/apisix-website that referenced this issue Mar 3, 2022
* feat: preview pluginchart (apache#456)

* feat: added pluginchart preview in route step4

* feat: change PluginChart to PluginOrchestration

* add tools to check ASF headers in code files. (apache#454)

* chore: remove unnecessary license file (apache#462)

* remove unnecessary license file

* remove unnecessary license file for `api7 dashboard`

* Increase the checking of .conf and .toml files. And delete the redundant configuration of the ASF-Release.cfg file. (apache#461)

* Increase the checking of .conf and .toml files.

* Skip the check of dag-to-lua-1.1/README.md file

* Put the "run Makefile" check before "get lua lib".

* Put the "run Makefile" check before "get lua lib".

* Put the "run Makefile" check before "get lua lib".

Co-authored-by: lin <lin@MBPro.local>

* ci: Add lint (apache#455)

Co-authored-by: Rapiz <code@rapiz.me>

* Feat: dashboard support route group (apache#433)

* feat: route group UI

* feat(route-ui): add routegroup when create route

* fix: add routegroup to route list

* fix: support add routegroup together with route

* fix: route path define error

* feat: trigger redeploy

* fix: update i18n key

Co-authored-by: 琚致远 <juzhiyuan@apache.org>

* feature:Independent license check operation file. (apache#465)

* feat: support ungroup in manager api (apache#460)

* feat: support ungroup in manager api

* fix: synchronize route group to route

* fix: update test case

* feat: add publish status to route in manager api (apache#450)

* feat: add publish status to route in manager api

* fix: update publish and offline route

* feat: add route publish test module

* fix: synchronize content for route publish/offline

* feat(route): add publish and offline to route (apache#451)

* feat(route): add publish and offline to route

* feat: trigger redeploy

* feat: trigger redeploy

* Update Create.tsx

* fix: update refer to the code review

* fix: init status default value

* fix: add a help msg to status Form.Item

Co-authored-by: 琚致远 <juzhiyuan@apache.org>

* feat: remove netlify (apache#472)

* fix: host should not be required (apache#477)

* feat: added new plugin dependency (apache#475)

* feat: added new plugin dependency

* feat: omit shadow var

* feat: omit shadow var

* fix: host should not be required (apache#479)

* fix: host should not be required

* feat: remove required rule

* feat: Route debug (apache#485)

* feat: new api get route and apisix url

* feat: online debug

* fix: update refer to the review, fix logical error as well

* fix: rename getRouteWithApisixUrl

* feat: update plugin (apache#482)

* feat: improve route (apache#483)

* feat: improve step1

* feat: improve step2

* feat: improve createStep4

* feat: improve transform

* fix: event loop

* feat: clean code

* fix: lost route_group info when enable redirect

* feat: UI improve

* fix: checkHostWithSSL with empty hosts

* Update Create.tsx

Co-authored-by: Firstsawyou <52862365+Firstsawyou@users.noreply.github.com>
Co-authored-by: nic-chen <33000667+nic-chen@users.noreply.github.com>
Co-authored-by: lin <lin@MBPro.local>
Co-authored-by: Rapiz <contact@rapiz.me>
Co-authored-by: Rapiz <code@rapiz.me>
Co-authored-by: liuxiran <belovedxixi@126.com>
Co-authored-by: 琚致远 <juzhiyuan@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
5 participants