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 custom metadata for managed site indexing #8859

Closed
wants to merge 2 commits into from

Conversation

kyletaylored
Copy link
Contributor

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

Kyle Taylor added 2 commits January 31, 2024 13:20
Sometimes categories will be undefined when used raw, so replace with the processed version that is inline with the Open Graph schema.
Copy link

⚡ Deployed with Pantheon Decoupled

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

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

@rachelwhitton
Copy link
Member

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

@kyletaylored
Copy link
Contributor Author

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.

@stevector
Copy link
Contributor

@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/

Copy link
Contributor

@stevector stevector left a comment

Choose a reason for hiding this comment

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

@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 stevector assigned stevector and unassigned stevector Mar 28, 2024
@kyletaylored
Copy link
Contributor Author

@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.

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.

3 participants