search

aiven / devportal

Resources for users of the projects on the Aiven platform
https://docs.aiven.io
Creative Commons Attribution 4.0 International
60 stars 53 forks source link

SEO: Have more descriptive text in linktexts #1276

Closed laysauchoa closed 1 year ago

laysauchoa commented 2 years ago

Checking devportal website with Lighthouse tool, we have performed average (83/100) on SEO. To be considered good, we need to be above 90 points.

These checks ensure that devportal page is following basic search engine optimization advice.

Problem found: It found 10 links which the link text has not descriptive text. They are all located in the landing page https://developer.aiven.io/

For example: …products/postgresql (developer.aiven.io) Read more

As explained, descriptive link text helps search engines understand your content. You can read more: https://web.dev/link-text/?utm_source=lighthouse&utm_medium=devtools

Proposed solution: The solution for this is to include some more specific descriptions in the link text. I am adding some proposals here which would make it more specific, but feel free to add your thoughts on how would you solve that.

1) Use service name with logo on the button instead of Read more

2) Use service name without logo on the button instead of Read more. Have logo on the beginning of the box.

lornajane commented 2 years ago

I would prefer that we do not make this change. If the buttons are confusing our users, let's get some advice from our UX colleagues on what would make this landing page more understandable and inclusive for all.

laysauchoa commented 2 years ago

@lornajane would be possible to tag the colleagues that can help us with that? thanks

staceysalamon-aiven commented 2 years ago

@lornajane @laysauchoa I'm happy to work on this from a UX copy perspective and discuss with the design team as needed. :)

laysauchoa commented 2 years ago

This would be amazing @staceysalamon-aiven thank you so much! I am available for any questions or help from our side.

staceysalamon-aiven commented 2 years ago

@laysauchoa @lornajane I think the best option for the product cards might be to change the button text to: "Learn about [PRODUCT]". It's more accessible and better for SEO, but I think also short enough to look okay and be easily scannable.

For the tools, we could do the same thing or have the button text read: "Get started with Aiven CLI" (Same for the API, etc.). This is a little more descriptive and since the main pages have a getting started/quick start section, it seems appropriate. Some of them might be a little long, though.

The Aiven Console is the one exception - we could change this text to: "Launch Aiven Console". But, I'll be adding an Aiven Console overview article soon, so we'll have something for that!

Let me know your thoughts! 🙏

staceysalamon-aiven commented 2 years ago

@edithyeghiazaryan Hi! We are looking at updating the button text on the main page and would like to get your advice on whether or not this would work from an SEO perspective (or any other thoughts you have)?

Hope that makes sense and thanks in advance for your help!

image

image

edithyeghiazaryan commented 2 years ago

@staceysalamon-aiven Regarding the buttons, updating the button texts (button anchor text) with more descriptive ones is a very nice idea! The short answer is yes.

We don’t even need the buttons here. Instead, we could adjust the subheadings and turn them into links/CTAs.

Here is an SEO brief to optimize the Aiven Documentation page even more by improving the meta data, internal linking, anchor texts, etc. https://www.notion.so/ganztags/Devportal-Homepage-a5fc7333f5834da497c1e9919e7f6902 If you have questions, please let me know.

Should we open a separate request for this or continue here? @staceysalamon-aiven @laysauchoa @lornajane

laysauchoa commented 2 years ago

I also like @staceysalamon-aiven idea. I'm not sure visually how just the link would look like, so I'm more inclined to the descriptive button approach.

We can continue in the Issue here.

staceysalamon-aiven commented 2 years ago

@staceysalamon-aiven Regarding the buttons, updating the button texts (button anchor text) with more descriptive ones is a very nice idea! The short answer is yes.

We don’t even need the buttons here. Instead, we could adjust the subheadings and turn them into links/CTAs.

Here is an SEO brief to optimize the Aiven Documentation page even more by improving the meta data, internal linking, anchor texts, etc. https://www.notion.so/ganztags/Devportal-Homepage-a5fc7333f5834da497c1e9919e7f6902 If you have questions, please let me know.

Should we open a separate request for this or continue here? @staceysalamon-aiven @laysauchoa @lornajane

Thanks for looking at this!

I wasn't able to access the Notion page. I got this error: "You do not have access to ganztags.. Please contact an admin to add you as a member."

edithyeghiazaryan commented 2 years ago

@staceysalamon-aiven could you please request access? The agency we collaborate with will grant access.

staceysalamon-aiven commented 2 years ago

@edithyeghiazaryan Sure, could you DM me an email address? There is no button to do this in the error message, unfortunately. ☹️

edithyeghiazaryan commented 2 years ago

@staceysalamon-aiven I've requested it.

edithyeghiazaryan commented 2 years ago

@staceysalamon-aiven have you got the access already?

staceysalamon-aiven commented 2 years ago

@staceysalamon-aiven have you got the access already?

No, I'm afraid not.

staceysalamon-aiven commented 2 years ago

@edithyeghiazaryan I have access now! I will have a look and let you know of any questions. Thanks!

staceysalamon-aiven commented 2 years ago

@edithyeghiazaryan I've had some time to look through the SEO brief this morning and it looks like the recommendation for the button link text was similar to what I put above, at least for the Tools section.

image

image

Thanks!

edithyeghiazaryan commented 2 years ago

@staceysalamon-aiven Ganztags mentioned not to leave these buttons as they are now ("Read more" and nothing else) but to put descriptive text there. "Learn about PRODUCT" can work too. The same applies to tools - the idea you initially suggested works.

Not to confuse you; yes, the recommendations from Ganztags were very similar to yours. In other words, all the ideas that you proposed would only positively affect SEO. Therefore,

to answer your initial questions about the buttons' text;

In addition to all these can we also improve the meta description and meta title of that page? image

staceysalamon-aiven commented 2 years ago

@edithyeghiazaryan Thank you for that! I will include the changes to the page title and description in these updates, too.

@laysauchoa Shall we stick with the buttons then and go with the language in the first screenshots I showed above? Also, to change the title and description of this page I am assuming I just need to update the index.html file under _build, is that correct?

laysauchoa commented 1 year ago

Hi @staceysalamon-aiven the goal is to help us with the SEO performance, so thanks for bringing the suggestions and for the discussion. The proposal changes will impact the design of the devportal and needs to be discussed with the responsible for that to see if it is okay. I'm not sure who can help us with that.

staceysalamon-aiven commented 1 year ago

Thanks @laysauchoa!

@lornajane Could you let me know what you think and what the next steps should be for this? 🙏

lornajane commented 1 year ago

With the rebranding going on which impacts how these are presented (existing buttons become action links), let's wait for that to merge and then perhaps @staceysalamon-aiven you can apply the rewordings (both the descriptions and the action links) that are discussed here? I think this brings the best of both words together!

staceysalamon-aiven commented 1 year ago

@lornajane That sounds great! Happy to make the content changes when the rebranding is merged.