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.

Sign up for GitHub

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

Jump to bottom

[docs][ready to merge] meta updates for search #8142

Merged
merged 6 commits into from
Apr 22, 2019
Merged

[docs][ready to merge] meta updates for search #8142

merged 6 commits into from
Apr 22, 2019

Conversation

katydecorah
Copy link
Contributor

@katydecorah katydecorah commented Apr 11, 2019 •
edited by colleenmcginnis
Loading

Launch Checklist

  • briefly describe the changes in this PR

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.
  • sends a new prop site to ReactPageShell that will be appended to the title meta tag and be used in Swiftype/search to also add context to results.
  • updates the docs-page-shell to accept these new values.

Meta update check list:

  • add site prop to ReactPageShell
  • pass props to meta to be accepted in ReactPageShell
  • add contentType and language to frontmatter/meta
  • update docs-page-shell

For reviewer: how to test

Pull down branch and npm run start-docs

  • Title tag follows format: Page name | Mapbox GL JS | Mapbox
  • The contentType and language values are correct.
  • No errors logged to console (since docs-page-shell now has required props for site and contentType, we would see errors logged if we missed setting one or the other)
  • 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; since the structure of this docs site differs from other sites, contentType and language are set globally rather than in the traditional frontmatter.

🆕 The docs-page-shell now strips markdown from the description meta tag, so this PR will clean up the meta descriptions so they will look cleaner when shared on social media or in search.

Refs https://github.com/mapbox/documentation/issues/159

@katydecorah katydecorah changed the title [docs][work in progress] meta updates for search [docs] meta updates for search Apr 11, 2019
@katydecorah katydecorah marked this pull request as ready for review April 11, 2019 18:05
colleenmcginnis
colleenmcginnis approved these changes Apr 16, 2019
View reviewed changes
Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

One small comment @katydecorah 💃

docs/pages/examples.js Outdated Show resolved Hide resolved
@katydecorah
Copy link
Contributor Author

@ryanhamley I'm not sure why test-flow is failing as the error message seems unrelated to this PR. The tests pass locally. Would you mind restarting the test? 🙏

@katydecorah katydecorah changed the title [docs] meta updates for search [docs][ready to merge] meta updates for search Apr 17, 2019
@katydecorah katydecorah merged commit 2aaab27 into publisher-production Apr 22, 2019
@katydecorah katydecorah deleted the meta branch April 22, 2019 18:15
vakila pushed a commit that referenced this pull request May 30, 2019
Merge branch 'publisher-production' (#8305)
884db58 
* Set default thumbnail for examples page for development (#8025)

* Set default thumbnail

* Add a little guidance about creating example images

* creates placeholder.png

* v0.54.0-beta.1 (#8084)

* CP removeFeatureState fix (#8090)

* Empty out features whose states have been removed instead of removing the feature object. This allows updating the buffers for features whose state has been removed, but also requires keep track of previously removed features.

* Update Changelog

* v0.54.0 (#8115)

* Example for `fill-pattern` (#8022)

* move docs dependencies to dev (#8121) (#8129)

* Mapbox-gl-geocoder v4 examples (#8053)

* add geocoder custom render example

* language localize example

* Update marker demo to use built-in marker function

* remove proximity bias for gl-geocoder example because this is now default behavior

* update point from geocode demo to set custom marker color

* update examples to use new mapbox-gl-geocoder API options

* lint new examples

* Update examples to gl-geocoder 4.0.0 api

* Options should be added to the geocoder, not the map

* lint examples

* remove templating syntax

* lint fixes

* @katydecorah 's code review fixes

* Studio does support rtl plugin (#8135)

* Update comment for setRTLTextPlugin (#8143)

* update comment for setRTLTextPlugin

* clarify wording in example

* update one more frame after canvas source paused (#8130) (#8163)

* update one more frame after canvas source paused

Calling `canvasSource.pause()` lets us know we can stop pulling in
updates from it. Since it is possible that changes were made to the
canvas source since the last render we should pull in one more update
before stopping. This also lets you call play and pause immediately to
render just one frame:

ctx.fillRect(10, 10, 50, 50);
canvasSource.play();
canvasSource.pause();

* add test

* don't render changes made after canvasSource.pause()

* optimize

* optimize

* Bugfix - removeFeatureState fails with target.id === 0 (#8150) (#8164)

* Fix an edge case where 0 target.id would fail to clear the feature state

* Check for number & string explicitly

* Add tests for 0 feature ID

* Fix logical check

* v0.54.0-beta.2 (#8166)

* [docs] meta updates for search (#8142)

* update docs-page-shell, update page-shell; update page meta

* Update react-page-shell.js

* remove contentType from examples page

* Update react-page-shell.js

* Update react-page-shell.js

* [docs] token refactor in docs-page-shell (#8174)

* Update page-shell-script.js

* do not force production page shell

* remove hardcoded token from example, add unit test to look for access token in example html files

* [docs] token refactor in docs-page-shell (#8174) (#8181)

* Update page-shell-script.js

* do not force production page shell

* remove hardcoded token from example, add unit test to look for access token in example html files

* Fix disappearing controls in Safari 12+ (#8193) (#8194)

* workaround for a Safari 12 bug with disappearing controls

* fix css lint

* v0.54.0 (take two) (#8184)

* v0.54.0

* update changelog once more

* fix imagery endpoint on WMS example (#8203)

* [email protected] (#8212)

* [docs] add trailing slash to `pathname` so resolved URL matches the canonical (#8228)

* Update documentation.yml (#8230)

* update mapbox-gl-geocoder to v4.3.0 (#8231)

* @mapbox/mapbox gl style [email protected] (#8264)

* Prepare @mapbox/[email protected]

* Add changelog of relevant items

* Add sku token to Mapbox API tile requests (#14) (#8276)

* v1.0.0 (#8277)

* [docs] update docs-page-shell (#8254)

* fix pathname

* Update react-page-shell.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@colleenmcginnis colleenmcginnis colleenmcginnis approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@katydecorah @colleenmcginnis