Add Schema.org structured microdata to docs.gitlab.com
What
Add Schema.org structured microdata to the documentation website
Why
- To improve our site search (Algolia can index microdata and use it for the search algorithm (#134 (closed))
- To improve Google search results for our docs (SEO)
Context
Some context on Schema.org structured microdata:
What is it/what it does:
- Contextualize HTML markup: "Schema.org provides a collection of shared vocabularies webmasters can use to markup their pages in ways that can be understood by the major search engines: Google, Microsoft, Yandex and Yahoo!" [ref]
- Allow search engines to better understand what information is contained on each web page.
Why it is important:
- "It provides you a set of pattern or structure to organize your content as expected by search engines." [ref]
- Search engines display result in rich snippets from the microdata
- Recommended by Google, which provides a testing tool
- Improves social discovery [ref]
- Makes the content more discoverable
- In the future, if we want, can be used together with AMP (important for mobile devices)
How
Implement it incrementally. Start small, test, see how it looks like, if it's worth it, add it deeply.
For a start:
-
Organization microdata -
Website microdata -
SearchAction microdata => https://gitlab.com/gitlab-com/gitlab-docs/issues/162 -
SiteNavigation microdata
Afterwards:
- WebPage microdata
- Article microdata
Very good guide: https://searchengineland.com/schema-markup-structured-data-seo-opportunities-site-type-231077
Edited by Marcia Ramos