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

Strategic content tweaks for better search results #2089

Merged
merged 8 commits into from
Nov 22, 2022
Rate limit · GitHub

Whoa there!

You have triggered an abuse detection mechanism.

Please wait a few minutes before you try again;
in some cases this may take up to an hour.

Conversation

delucis
Copy link
Member

@delucis delucis commented Nov 22, 2022

What kind of changes does this PR include?

  • Minor content fixes (broken links, typos, etc.)

Description

Went through the top 60 search terms for the past 30 days to try to see what might be improved through some strategic content tweaks.

Most of this boils down to:

  1. Use terms we want to match as high as possible in the page hierarchy for results we want to show. For example, if a user searches for “style”, make sure “style” is in the page title or <h2> for results we want them to see.
  2. Avoid terms in the same places if we don’t want that content to rank highly in search. For example, if a user searches for “style” and we don’t want our tutorial page “Add a Gangnam Style translation blog post” to match, we could rename it to “Add a lyrics translation blog post”.

Here are all my tweaks:

  • Avoid “global” in tutorial page title
    Ranks high for searches for “glob” which we’d like to have better results for.

  • Remove “styled” from tutorial page title
    Ranks highly for “style” searches and isn’t as helpful as our CSS guide.

  • Use “Styles” instead of “Styling“ in title to match “style” searches
    People often search for “style” which is not an exact match to “styling”. Changing this should help ranking slightly.

  • Use “styling” instead of “styles” to avoid matching “style” searches
    Apply the inverse logic to help reduce the ranking of this tutorial page.

  • Avoid “frontmatter” in tutorial <h2>
    “frontmatter” in other pages is always in an <h3> so is ranking lower, avoding this here to ensure better results rank higher.

  • Include “SCSS” in Sass heading
    “SCSS” and “Sass” are often use interchangeably, including both in the subheading should produce a better search result.

  • Avoid “HTML” in tutorial heading
    Searches for “html” ranked this tutorial page ahead of more helpful guide content

  • Avoid “JavaScript” in tutorial page title
    More than 100 people searched this recently and our imports guide content is probably the best result.

Happy to tweak any of these further or revert if they seem like overreach.

Ranks high for searches for “glob” which we’d like to have better results for.
Ranks highly for “style” searches and isn’t as helpful as our CSS guide.
People often search for “style” which is not an exact match to “styling”. Changing this should help ranking slightly.
Apply the inverse logic to help reduce the ranking of this tutorial page.
“frontmatter” in other pages is always in an `<h3>` so is ranking lower, avoding this here to ensure better results rank higher.
“SCSS” and “Sass” are often use interchangeably, including both in the subheading should produce a better search result.
Searches for “html” ranked this tutorial page ahead of more helpful guide content
More than 100 people searched this recently and our imports guide content is probably the best result.
@delucis delucis added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label Nov 22, 2022
@netlify
Copy link

netlify bot commented Nov 22, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit b2be13b
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/637cae3bba026a0008433af3
😎 Deploy Preview https://deploy-preview-2089--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@delucis delucis changed the title Avoid “global” in tutorial page title Strategic content tweaks for better search results Nov 22, 2022
@delucis delucis self-assigned this Nov 22, 2022
@sarah11918
Copy link
Member

These all look great! Ship it!

@delucis delucis merged commit 314ba69 into main Nov 22, 2022
@delucis delucis deleted the chris/strategic-renames branch November 22, 2022 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rate limit · GitHub

Whoa there!

You have triggered an abuse detection mechanism.

Please wait a few minutes before you try again;
in some cases this may take up to an hour.

2 participants