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

Add YAML description meta tags #2582

Merged
merged 5 commits into from
Oct 30, 2023
Merged

Conversation

guimachiavelli
Copy link
Member

Fixes #2573

@github-actions
Copy link

All broken links are now fixed, thank you!

@guimachiavelli guimachiavelli marked this pull request as ready for review October 17, 2023 17:10
@guimachiavelli guimachiavelli requested review from qdequele and removed request for CaroFG October 17, 2023 17:11
Copy link
Member

@qdequele qdequele left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @guimachiavelli it's great! Is it also possible to add the titles? I did it in my test PR. https://github.com/meilisearch/documentation/pull/2571/files

@guimachiavelli
Copy link
Member Author

Hi @qdequele! My plan is to address the titles programmatically, as the majority should really be [Page's H1] — Meilisearch documentation. So, for example, the page title for the cloud getting started would be Getting started with Meilisearch Cloud — Meilisearch documentation. I'm looking into how to do that, but I believe we might be able to skip basement.

@guimachiavelli
Copy link
Member Author

After some research, <title>s were not implemented in a way we can easily and safely customise. Skipping basement and doing it ourselves does not look like a good choice.

Taking in consideration the time it will take for basement to do this, though, I have manually edited the <title> for each documentation page.

At a later date, once they're done with our current requests, we'll investigate how we can properly automate this.

qdequele
qdequele previously approved these changes Oct 26, 2023
Copy link
Member

@qdequele qdequele left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@guimachiavelli guimachiavelli merged commit eca36a6 into main Oct 30, 2023
2 checks passed
@guimachiavelli guimachiavelli deleted the yaml-frontmatter-description-seo branch October 30, 2023 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add description to YAML front matter to improve SEO rankings
3 participants