documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Add custom metadata for managed site indexing

Open kyletaylored opened this issue 1 year ago • 4 comments

Summary

Add custom meta tags for indexing the site for a datastore

Effect

Most of the data contained in the markdown files is structured, but is not exposed in a way easily accessible by crawlers (or exposed at all). This PR adds custom meta tags to the site to expose this data that can then be crawled and extracted in a very clean way. It does not affect any existing tags, nor does it use any standard OpenGraph or other standards that may interfere or be picked up by other crawlers (SEO, search indexers, etc).

image


Post Launch

Do not remove - To be completed by the docs team upon merge:

  • [ ] Redirect /old-path/ => /new-path/ (if applicable)
  • [ ] Include/exclude pages ^ respectively within docs search service provider (if applicable)
  • [ ] For Heroes - add a props post to the discussion board.
  • [ ] Remove from the project board

kyletaylored avatar Feb 02 '24 21:02 kyletaylored

:zap: Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

:eyes: Preview: https://pr-8859-documentation.appa.pantheon.site :hammer_and_wrench: Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

pantheon-decoupled[bot] avatar Feb 02 '24 21:02 pantheon-decoupled[bot]

@kyletaylored this looks great! Do you still have work planned or is this PR ready to merge?

rachelwhitton avatar Feb 07 '24 17:02 rachelwhitton

I think the only thing I was going to add was a consistent class or ID around only the body content of a doc or guide page (excluding the title header section). Thoughts on that? There doesn't seem to be a consistent implementation, but I could make one.

kyletaylored avatar Feb 07 '24 17:02 kyletaylored

@kyletaylored can you point your config to read the environment for this PR to verify that you're getting the behavior you want? https://pr-8859-documentation.appa.pantheon.site/

stevector avatar Feb 15 '24 19:02 stevector

@stevector The current service is an auto-indexer that makes its own assumptions about the content being indexed (and to repoint we would have to go through the Google search console approval process again). This PR is meant to be used with a custom crawler that has not been written yet, and there is no current plan to do so.

If we think it's valuable, we can merge as-is. If not or we find it unnecessary until a future date, we can just close this.

kyletaylored avatar Mar 29 '24 16:03 kyletaylored