[docs] update meta for search - Githubissues

mapbox / mapbox.js

Mapbox JavaScript API, a Leaflet Plugin

mapbox.com/mapbox.js/

Other

1.92k stars 386 forks source link

[docs] update meta for search #1290

Closed katydecorah closed 5 years ago

katydecorah commented 5 years ago

Testing changes in https://github.com/mapbox/docs-page-shell/pull/38 will accept contentType, site, level, and language.

This PR:

adds a new frontmatter item contentType and language to help us categorize each page. This will be helpful when we roll out search/Swiftype to add context to results.
updates the default layout to accept these new values.

For contributor: how to update

[x] add title to config
[x] add contentType: <value> to layout frontmatter, see possible values and language
[x] update default layout

For reviewer: how to test

Pull down branch and bundle exec jekyll

[x] Title tag follows format: Page name | Mapbox.js | Mapbox
[x] The contentType and language values are correct.
[x] When you inspect the page and look at the meta tags in the head, you see the new swiftype meta tags

Note: this site doesn't use level

katydecorah commented 5 years ago

Thanks for flagging @HeyStenson I wasn't sure of good contentType for the Plugins page so I decided to omit for now. Thinking we can circle back if it shows up in Swiftype in an undesired way.