Build out Gatsby media information in docs #12906
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
March 27, 2019 18:47
DSchau
reviewed
Mar 28, 2019
jlengstorf
reviewed
Mar 28, 2019
docs/docs/importing-media-content.md
Outdated
| Using canvas and/or WebGL may require modifying your Webpack config. Do you have experience with making this work in your Gatsby site? Contribute to the docs by adding more details to this page. | ||
|
|
||
| --- | ||
|
|
||
| This is a stub. Help our community expand it. |
There was a problem hiding this comment.
On this stub, the notice is at the bottom; on others, it's at the top. Should we make this consistent?
There was a problem hiding this comment.
@jlengstorf good point! I thought it made sense at the top for longer docs that we want people to fill in...but there's an automatic link inserted at the bottom pointing people to Github, so on the Video doc I just repeated it. This doc is light on WebGL / canvas content, so it does make sense for contributors to update it. But the Video one is more filled out, aside from the section on self-hosting/processing HTML5 video.
docs/docs/working-with-video.md
Outdated
| issue: https://github.com/gatsbyjs/gatsby/issues/12903 | ||
| --- | ||
|
|
||
| This is a stub. Help our community expand it. |
There was a problem hiding this comment.
Is this really a stub? This has a ton of information!
docs/docs/working-with-video.md
Outdated
|
|
||
| --- | ||
|
|
||
| This is a stub. Help our community expand it. |
There was a problem hiding this comment.
Looks like this is doubled up.
docs/docs/working-with-video.md
Outdated
| @@ -0,0 +1,156 @@ | |||
| --- | |||
| title: Working With Video* | |||
There was a problem hiding this comment.
I don't think the asterisk should be included here — it should only be in the sidebar YML to trigger the "stub" styling. (I think.)
There was a problem hiding this comment.
This is correct! Titles stay clean, the yaml gets updated with an asterisk!
docs/docs/working-with-video.md
Outdated
|
|
||
| ## Embedding hosted videos in Markdown | ||
|
|
||
| There are numerous Gatsby plugins for working with hosted video in your Markdown posts and pages. We recommend checking out the [gatsby-remark-embed-video](<(/packages/gatsby-remark-embed-video/?=video)>) plugin for sourcing from a variety of hosts. |
There was a problem hiding this comment.
This link looks broken (see the (<(). I think some weird wrapping happened?
There was a problem hiding this comment.
Oh yeah, looks like something weird with my editor. Will fix!
docs/docs/working-with-video.md
Outdated
|
|
||
| > This discussion is ongoing on Github, chime in with your ideas here: https://github.com/gatsbyjs/gatsby/issues/3346 | ||
|
|
||
| To include your own video files that will work in multiple web browsers and platforms, you'll need to read up a bit on video extensions and codecs. We recommend MDN as a resource: <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats">Media formats for HTML audio and video</a>. You may need video converter software to produce the necessary formats to support a range of devices and environments, such as `.webm` and `.mp4`. |
There was a problem hiding this comment.
Not a big deal, but why not use Markdown for this link?
There was a problem hiding this comment.
Good point, I think that was an old habit of writing HTML coming through!
docs/docs/working-with-video.md
Outdated
|
|
||
| One advantage of integrating a custom component with your own hosted video is it can give you more control over the video player, including its accessibility. It is strongly encouraged to provide captions and subtitles for your videos, and use a player with accessible controls. | ||
|
|
||
| Check out the accessible HTML5 video player for React from Paypal: https://github.com/paypal/accessible-html5-video-player#react-version |
There was a problem hiding this comment.
Should this be linkified?
There was a problem hiding this comment.
I thought Markdown would convert that automatically, but I will check! Thanks for the tip.
There was a problem hiding this comment.
It will — I should have clarified. I meant turning it into a named link, e.g. "PayPal has created an [accessible HTML5 video player](#link)."
muescha
reviewed
Mar 29, 2019
| The discussion around best practices for video in Gatsby is also ongoing on Github, chime in with your ideas here: https://github.com/gatsbyjs/gatsby/issues/3346 | ||
|
|
||
| --- | ||
|
|
There was a problem hiding this comment.
I miss a heading here like TOC or Overview. But I don't find the right wording now
There was a problem hiding this comment.
I'm not sure what you mean. The heading for the page is right above it (Working with Video). We've talked about creating more consistent patterns for TOC, such as in #6896. But I don't think that should hold up this PR!
There was a problem hiding this comment.
I did mean a header for the TOC.
But I did not find any doc with a header for TOC. Only some introducing sentence on some pages following by TOC or links to aubpages.
Co-Authored-By: marcysutton <[email protected]>
thanks for the feedback! Co-Authored-By: marcysutton <[email protected]>
|
I've updated the PR! Because the new pages had a lot of content, I opted to remove their stub status and include callouts asking for relevant community contributions instead. There will be more image docs improvements to come in future issues/PRs, so this one should be good to go unless there's more feedback! |
jlengstorf
approved these changes
Mar 29, 2019
shannonbux
approved these changes
Mar 30, 2019
There was a problem hiding this comment.
I think this looks excellent! I haven't looked into the search results on Algolia recently, so I assume the titles of the docs sort of match what people are searching for? If not, that'd be my only recommendation. I also need to look into how we've designed the search experience more (i.e. are we searching content of docs or just titles, can the search suggest alternate terms that they ought to be searching for, etc.)
|
This looks great! I have several comments about the "Images and Files" section in general -- not necessarily related to the work you've done but relating to the work around it. The work here helps a lot to organize a not-super-well-organized section. Some thoughts about how we could do more, whether in this PR or at a later date:
|
|
@calcsam thanks so much, your thinking is very much inline with what I had in mind for future PRs! I agree there are some great opportunities to improve the rest of the image docs as well. I'm planning to open issues for each major workflow to track in https://github.com/gatsbyjs/gatsby/projects/10; that will be one of the first to be opened so I'll follow up with it here. Meanwhile, I think these video/media docs are probably fine to move forward. |
Co-Authored-By: marcysutton <[email protected]>
Co-Authored-By: marcysutton <[email protected]>
dhurlburtusa
added a commit
that referenced
this pull request
Apr 3, 2019
* docs(gatsby-source-shopify): Add note about API permissions (#13037) Note which permissions you should enable on the Shopify Storefront API. Without these permissions you'll get a fairly cryptic error message. * chore(docs): match the Wording Style of Other Tutorial Parts (#13034) * chore(docs): fix typo in convincing others doc (#13033) <!-- Have any questions? Check out the contributing docs at https://gatsby.dev/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description Fixes a misspelled word. * fix(docs): expand guidelist on partnering with gatsby page (#13029) Following up on #12970. Current https://www.gatsbyjs.org/docs/partnering-with-gatsby/:  * fix(starters): update gatsby monorepo (#12925) This PR contains the following updates: | Package | Type | Update | Change | References | |---|---|---|---|---| | gatsby | dependencies | patch | [`^2.3.3` -> `^2.3.5`](https://diff.intrinsic.com/gatsby/2.3.3/2.3.5) | [source](https://github.com/gatsbyjs/gatsby) | | gatsby-image | dependencies | patch | [`^2.0.35` -> `^2.0.37`](https://diff.intrinsic.com/gatsby-image/2.0.35/2.0.37) | [source](https://github.com/gatsbyjs/gatsby) | | gatsby-plugin-manifest | dependencies | patch | [`^2.0.25` -> `^2.0.26`](https://diff.intrinsic.com/gatsby-plugin-manifest/2.0.25/2.0.26) | [source](https://github.com/gatsbyjs/gatsby) | --- ### Release Notes <details> <summary>gatsbyjs/gatsby</summary> ### [`v2.3.5`](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.5) [Compare Source](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.5) ### [`v2.3.4`](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.4) [Compare Source](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.4) </details> --- ### Renovate configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR becomes conflicted, or if you modify the PR title to begin with "`rebase!`". :ghost: **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/config-help/issues) if that's undesired. --- - [ ] <!-- renovate-rebase -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/marketplace/renovate). View repository job log [here](https://renovatebot.com/dashboard#gatsbyjs/gatsby). * feat(blog): add gatsby is great blog post (#12777) * chore: add blog post * chore: keep iterating * chore: more tweaks * feat: nearly finish up * chore: run tinypng * chore: fix some typos * chore: fix snippet * chore: add a gif, it gets the people going * chore: more * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * chore: change date * chore: tighten up last section * chore: change data * chore: update per feedback * chore(docs): replace absolute links with relative links (#12949) <!-- Have any questions? Check out the contributing docs at https://gatsby.dev/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description Suggest a more complete structure to the example gatsby-config.js file ## Related Issues Along with #12103 this PR fixes #11957 <!-- Link to the issue that is fixed by this PR (if there is one) e.g. Fixes #1234, Addresses #1234, Related to #1234, etc. --> * chore(showcase): Add Assortment to site showcase (#13002) ## Description Adding [assortment.io](https://assortment.io) to site showcase. Assortment is my Web Development blog that I've recently updated to Gatsby, Netlify, Netlify CMS and Emotion. It'd be cool to see it on the showcase 😃 * feat(gatsby-dev-cli): add verdaccio support (#11525) * feat(gatsby-dev-cli): add verdaccio support [wip] * yuck - don't look * just to verify verdaccio * fix gitignore and add htpasswd with dummy gatsby-dev user * some logging to understand why it tries to handle all the packages * just temporarily so it hopefully at least works * moar data * don't copy all the packages right now * don't rely on package name starting with "gatsby" heuristic * tmp commit * tmp * fs change * tmp * a * updates * remove random files that shouldn't be here * tmp * revert dep changes * ignore changes to package.json created during publishing * testing of dep change in gatsby-cli is picked up by gatsby-dev-cli * let's see if gatsby-dev will handle case of no node_modules * sanity check * adjust console message * add missing devDeps * more missing devDeps * grab package.json from unpkg if package is not yet installed locally * correctly ignore package.json changes during publishing * cleaning things up * htpasswd loc * restore gatsby package.json * adjust ignore files * gatsby-dev-cli: ignore tests * remove extra ln * less console output * turns out you don't need htpasswd after all * use exact when installing local packages - timestamp is used in version * why it failed? * use yarn for publishing - see verdaccio/verdaccio#997 * v0.1.1 * add temporary .npmrc file to allow anonymous publishes * add some jsdocs * update yarn.lock * oops * debug why still can't publish anon * adjust npmrc content * doh * Revert "debug why still can't publish anon" This reverts commit fc1045a. * handle package installation of deps didn't change * skip version changes for packages in gatsby mono-repo, queue copying instead of doing it immediately * fix tests * packages stored in verdaccio storage seems to be picked up by jest and causing trouble, so let's ignore verdaccio storage directory * bye "wat", you will be missed * bail early to avoid conditional bracket hell * more bailing early * more concise * new line * use exaca to simplify running yarn * clean up www/.gitignore * handle not existing packages * remove unused (was needed for basic auth) * cleanup temp file changes when process exit in middle of publishing * ops * Apply suggestions from code review Co-Authored-By: pieh <[email protected]> * cleanup unpkg response handler * move stuff around * remove tmp comment * document traversePackageDocs fn * restrcuture files * add basic tests for traversingPackageDeps * add basic tests for generating packages to publish (based on dep graph) * fix tests on windows * handle circular dependencies when constructing list of packages to publish * remove cat ;( * restore original e2e-test script * update gitignore * chore(release): Publish - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] * chore(release): Publish - [email protected] * docs(gatsby-dev-cli): Edit README (#13049) * Build out Gatsby media information in docs (#12906) * add video info, delete unnecessary stubs Related to #12903 * fix internal link for html5 video section * update videoTitle example Co-Authored-By: marcysutton <[email protected]> * Apply suggestions from code review thanks for the feedback! Co-Authored-By: marcysutton <[email protected]> * incorporate feedback, make into real docs!! * delete unused stubs * Update docs/docs/working-with-video.md Co-Authored-By: marcysutton <[email protected]> * Update docs/docs/working-with-video.md Co-Authored-By: marcysutton <[email protected]> * chore(gatsby): fix domready package to be compatible with ie10 (#13027) * changed domready package to domready-loaded which is compatible with ie10 * updated domready to @mikaelkristiansson/domready * updated packages/gatsby to use @mikaelkristiansson/domready * chore(release): Publish - [email protected] * feat(gatsby-transformer-react-docgen): use local babel config for react-docgen (#12001) * feat: use local babel config for react-docgen BREAKING CHANGE: now uses the local babel config with a fallback * Update README.md * chore(release): Publish - [email protected] * chore(docs): add “Why I used GatsbyJS (#12954) Why I used GatsbyJS <!-- Have any questions? Check out the contributing docs at https://gatsby.dev/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description <!-- Write a brief description of the changes introduced by this PR --> ## Related Issues <!-- Link to the issue that is fixed by this PR (if there is one) e.g. Fixes #1234, Addresses #1234, Related to #1234, etc. --> * feat(www): don't check for overview frontmatter (#13060) Fixes `[[guidelist]]` not being replaced in few pages (i.e. in https://www.gatsbyjs.org/docs/winning-over-stakeholders/ ) The code is handling cases when there are no children (tried building locally and it worked just fine). Follow up to this would be to clear `.md` files that use `overview` and adjust page query. But this is just quick fix. * chore(docs): add starter library to docs sidebar under starters (#12963) 40% of people visiting the starters page go here next, so we should probably add this:  * chore(showcase): Add gmartinez.dev to showcase (#13067) <!-- Have any questions? Check out the contributing docs at https://gatsby.dev/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description Adding gmartinez.dev to showcase list in site.yml <!-- Link to the issue that is fixed by this PR (if there is one) e.g. Fixes #1234, Addresses #1234, Related to #1234, etc. --> Co-authored-by: Lennart <[email protected]> * fix(gatsby): don't try to statically analyze gatsby-node, require it and examine exports instead (#13053) * fix: don't try to statically analyze gatsby-node, require it and examine exports instead * differentiate test names * Update packages/gatsby/src/bootstrap/resolve-module-exports.js Co-Authored-By: pieh <[email protected]> * chore(release): Publish - [email protected] * Use Loki's elemMatch operator (#13025) * feat(gatsby): add util.promisify polyfill for older node version (#13024) * refactor(gatsby): gatsby develop: cleanup port detection (#13006) * chore(release): Publish - [email protected] * fix(gatsby): ignore __esModule export in gatsby-node exports (#13081) I introduced bug/regression in #13053 by not removing `__esModule` export name from resolved export names - it break some plugins Fixes: #13079 * chore(release): Publish - [email protected] * fix(www): Hubspot form UI (#13080) * fix(www): Work around HubSpot’s CSS being loaded …by pulling in react-hubspot-form locally, and modifying it slightly. See comment in `www/src/components/react-hubspot-form` for more info. * Fix `formInput` styles … now matching the reference homepage newsletter form — no more Futura PT for input text. * Return nothing because linter * Make into Two Words
|
Woo! |
DSchau
pushed a commit
that referenced
this pull request
Apr 4, 2019
* Fix Comma Usage * Fix Comma Usage; Misc Improvements (#13038) * Fix Misuse of Commas, Et Al (#13039) Use em dash in place of two hyphens. Format paragraph to be on one line (apparently the convention). * Fix Comma Usage and Do Some Misc Changes (#13040) * Fix Comma Usage and Do Some Misc Changes Do code formatting to match rest of file. Use em dash instead of two hyphens. Etc. * Update HTML Entity * Add Hyphen for Clarity (#13042) * Fix Comma Usage in Blog (#13085) * docs(gatsby-source-shopify): Add note about API permissions (#13037) Note which permissions you should enable on the Shopify Storefront API. Without these permissions you'll get a fairly cryptic error message. * chore(docs): match the Wording Style of Other Tutorial Parts (#13034) * chore(docs): fix typo in convincing others doc (#13033) <!-- Have any questions? Check out the contributing docs at https://gatsby.dev/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description Fixes a misspelled word. * fix(docs): expand guidelist on partnering with gatsby page (#13029) Following up on #12970. Current https://www.gatsbyjs.org/docs/partnering-with-gatsby/:  * fix(starters): update gatsby monorepo (#12925) This PR contains the following updates: | Package | Type | Update | Change | References | |---|---|---|---|---| | gatsby | dependencies | patch | [`^2.3.3` -> `^2.3.5`](https://diff.intrinsic.com/gatsby/2.3.3/2.3.5) | [source](https://github.com/gatsbyjs/gatsby) | | gatsby-image | dependencies | patch | [`^2.0.35` -> `^2.0.37`](https://diff.intrinsic.com/gatsby-image/2.0.35/2.0.37) | [source](https://github.com/gatsbyjs/gatsby) | | gatsby-plugin-manifest | dependencies | patch | [`^2.0.25` -> `^2.0.26`](https://diff.intrinsic.com/gatsby-plugin-manifest/2.0.25/2.0.26) | [source](https://github.com/gatsbyjs/gatsby) | --- ### Release Notes <details> <summary>gatsbyjs/gatsby</summary> ### [`v2.3.5`](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.5) [Compare Source](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.5) ### [`v2.3.4`](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.4) [Compare Source](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.4) </details> --- ### Renovate configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR becomes conflicted, or if you modify the PR title to begin with "`rebase!`". :ghost: **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/config-help/issues) if that's undesired. --- - [ ] <!-- renovate-rebase -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/marketplace/renovate). View repository job log [here](https://renovatebot.com/dashboard#gatsbyjs/gatsby). * feat(blog): add gatsby is great blog post (#12777) * chore: add blog post * chore: keep iterating * chore: more tweaks * feat: nearly finish up * chore: run tinypng * chore: fix some typos * chore: fix snippet * chore: add a gif, it gets the people going * chore: more * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * chore: change date * chore: tighten up last section * chore: change data * chore: update per feedback * chore(docs): replace absolute links with relative links (#12949) <!-- Have any questions? Check out the contributing docs at https://gatsby.dev/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description Suggest a more complete structure to the example gatsby-config.js file ## Related Issues Along with #12103 this PR fixes #11957 <!-- Link to the issue that is fixed by this PR (if there is one) e.g. Fixes #1234, Addresses #1234, Related to #1234, etc. --> * chore(showcase): Add Assortment to site showcase (#13002) ## Description Adding [assortment.io](https://assortment.io) to site showcase. Assortment is my Web Development blog that I've recently updated to Gatsby, Netlify, Netlify CMS and Emotion. It'd be cool to see it on the showcase 😃 * Fix Comma Usage; Misc Updates * Make into Two Words (#13084) * docs(gatsby-source-shopify): Add note about API permissions (#13037) Note which permissions you should enable on the Shopify Storefront API. Without these permissions you'll get a fairly cryptic error message. * chore(docs): match the Wording Style of Other Tutorial Parts (#13034) * chore(docs): fix typo in convincing others doc (#13033) <!-- Have any questions? Check out the contributing docs at https://gatsby.dev/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description Fixes a misspelled word. * fix(docs): expand guidelist on partnering with gatsby page (#13029) Following up on #12970. Current https://www.gatsbyjs.org/docs/partnering-with-gatsby/:  * fix(starters): update gatsby monorepo (#12925) This PR contains the following updates: | Package | Type | Update | Change | References | |---|---|---|---|---| | gatsby | dependencies | patch | [`^2.3.3` -> `^2.3.5`](https://diff.intrinsic.com/gatsby/2.3.3/2.3.5) | [source](https://github.com/gatsbyjs/gatsby) | | gatsby-image | dependencies | patch | [`^2.0.35` -> `^2.0.37`](https://diff.intrinsic.com/gatsby-image/2.0.35/2.0.37) | [source](https://github.com/gatsbyjs/gatsby) | | gatsby-plugin-manifest | dependencies | patch | [`^2.0.25` -> `^2.0.26`](https://diff.intrinsic.com/gatsby-plugin-manifest/2.0.25/2.0.26) | [source](https://github.com/gatsbyjs/gatsby) | --- ### Release Notes <details> <summary>gatsbyjs/gatsby</summary> ### [`v2.3.5`](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.5) [Compare Source](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.5) ### [`v2.3.4`](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.4) [Compare Source](https://github.com/gatsbyjs/gatsby/compare/[email protected]@2.3.4) </details> --- ### Renovate configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR becomes conflicted, or if you modify the PR title to begin with "`rebase!`". :ghost: **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/config-help/issues) if that's undesired. --- - [ ] <!-- renovate-rebase -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/marketplace/renovate). View repository job log [here](https://renovatebot.com/dashboard#gatsbyjs/gatsby). * feat(blog): add gatsby is great blog post (#12777) * chore: add blog post * chore: keep iterating * chore: more tweaks * feat: nearly finish up * chore: run tinypng * chore: fix some typos * chore: fix snippet * chore: add a gif, it gets the people going * chore: more * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * Update docs/blog/2019-03-25-behind-the-scenes-what-makes-gatsby-great/index.md Co-Authored-By: DSchau <[email protected]> * chore: change date * chore: tighten up last section * chore: change data * chore: update per feedback * chore(docs): replace absolute links with relative links (#12949) <!-- Have any questions? Check out the contributing docs at https://gatsby.dev/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description Suggest a more complete structure to the example gatsby-config.js file ## Related Issues Along with #12103 this PR fixes #11957 <!-- Link to the issue that is fixed by this PR (if there is one) e.g. Fixes #1234, Addresses #1234, Related to #1234, etc. --> * chore(showcase): Add Assortment to site showcase (#13002) ## Description Adding [assortment.io](https://assortment.io) to site showcase. Assortment is my Web Development blog that I've recently updated to Gatsby, Netlify, Netlify CMS and Emotion. It'd be cool to see it on the showcase 😃 * feat(gatsby-dev-cli): add verdaccio support (#11525) * feat(gatsby-dev-cli): add verdaccio support [wip] * yuck - don't look * just to verify verdaccio * fix gitignore and add htpasswd with dummy gatsby-dev user * some logging to understand why it tries to handle all the packages * just temporarily so it hopefully at least works * moar data * don't copy all the packages right now * don't rely on package name starting with "gatsby" heuristic * tmp commit * tmp * fs change * tmp * a * updates * remove random files that shouldn't be here * tmp * revert dep changes * ignore changes to package.json created during publishing * testing of dep change in gatsby-cli is picked up by gatsby-dev-cli * let's see if gatsby-dev will handle case of no node_modules * sanity check * adjust console message * add missing devDeps * more missing devDeps * grab package.json from unpkg if package is not yet installed locally * correctly ignore package.json changes during publishing * cleaning things up * htpasswd loc * restore gatsby package.json * adjust ignore files * gatsby-dev-cli: ignore tests * remove extra ln * less console output * turns out you don't need htpasswd after all * use exact when installing local packages - timestamp is used in version * why it failed? * use yarn for publishing - see verdaccio/verdaccio#997 * v0.1.1 * add temporary .npmrc file to allow anonymous publishes * add some jsdocs * update yarn.lock * oops * debug why still can't publish anon * adjust npmrc content * doh * Revert "debug why still can't publish anon" This reverts commit fc1045a. * handle package installation of deps didn't change * skip version changes for packages in gatsby mono-repo, queue copying instead of doing it immediately * fix tests * packages stored in verdaccio storage seems to be picked up by jest and causing trouble, so let's ignore verdaccio storage directory * bye "wat", you will be missed * bail early to avoid conditional bracket hell * more bailing early * more concise * new line * use exaca to simplify running yarn * clean up www/.gitignore * handle not existing packages * remove unused (was needed for basic auth) * cleanup temp file changes when process exit in middle of publishing * ops * Apply suggestions from code review Co-Authored-By: pieh <[email protected]> * cleanup unpkg response handler * move stuff around * remove tmp comment * document traversePackageDocs fn * restrcuture files * add basic tests for traversingPackageDeps * add basic tests for generating packages to publish (based on dep graph) * fix tests on windows * handle circular dependencies when constructing list of packages to publish * remove cat ;( * restore original e2e-test script * update gitignore * chore(release): Publish - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] * chore(release): Publish - [email protected] * docs(gatsby-dev-cli): Edit README (#13049) * Build out Gatsby media information in docs (#12906) * add video info, delete unnecessary stubs Related to #12903 * fix internal link for html5 video section * update videoTitle example Co-Authored-By: marcysutton <[email protected]> * Apply suggestions from code review thanks for the feedback! Co-Authored-By: marcysutton <[email protected]> * incorporate feedback, make into real docs!! * delete unused stubs * Update docs/docs/working-with-video.md Co-Authored-By: marcysutton <[email protected]> * Update docs/docs/working-with-video.md Co-Authored-By: marcysutton <[email protected]> * chore(gatsby): fix domready package to be compatible with ie10 (#13027) * changed domready package to domready-loaded which is compatible with ie10 * updated domready to @mikaelkristiansson/domready * updated packages/gatsby to use @mikaelkristiansson/domready * chore(release): Publish - [email protected] * feat(gatsby-transformer-react-docgen): use local babel config for react-docgen (#12001) * feat: use local babel config for react-docgen BREAKING CHANGE: now uses the local babel config with a fallback * Update README.md * chore(release): Publish - [email protected] * chore(docs): add “Why I used GatsbyJS (#12954) Why I used GatsbyJS <!-- Have any questions? Check out the contributing docs at https://gatsby.dev/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description <!-- Write a brief description of the changes introduced by this PR --> ## Related Issues <!-- Link to the issue that is fixed by this PR (if there is one) e.g. Fixes #1234, Addresses #1234, Related to #1234, etc. --> * feat(www): don't check for overview frontmatter (#13060) Fixes `[[guidelist]]` not being replaced in few pages (i.e. in https://www.gatsbyjs.org/docs/winning-over-stakeholders/ ) The code is handling cases when there are no children (tried building locally and it worked just fine). Follow up to this would be to clear `.md` files that use `overview` and adjust page query. But this is just quick fix. * chore(docs): add starter library to docs sidebar under starters (#12963) 40% of people visiting the starters page go here next, so we should probably add this:  * chore(showcase): Add gmartinez.dev to showcase (#13067) <!-- Have any questions? Check out the contributing docs at https://gatsby.dev/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description Adding gmartinez.dev to showcase list in site.yml <!-- Link to the issue that is fixed by this PR (if there is one) e.g. Fixes #1234, Addresses #1234, Related to #1234, etc. --> Co-authored-by: Lennart <[email protected]> * fix(gatsby): don't try to statically analyze gatsby-node, require it and examine exports instead (#13053) * fix: don't try to statically analyze gatsby-node, require it and examine exports instead * differentiate test names * Update packages/gatsby/src/bootstrap/resolve-module-exports.js Co-Authored-By: pieh <[email protected]> * chore(release): Publish - [email protected] * Use Loki's elemMatch operator (#13025) * feat(gatsby): add util.promisify polyfill for older node version (#13024) * refactor(gatsby): gatsby develop: cleanup port detection (#13006) * chore(release): Publish - [email protected] * fix(gatsby): ignore __esModule export in gatsby-node exports (#13081) I introduced bug/regression in #13053 by not removing `__esModule` export name from resolved export names - it break some plugins Fixes: #13079 * chore(release): Publish - [email protected] * fix(www): Hubspot form UI (#13080) * fix(www): Work around HubSpot’s CSS being loaded …by pulling in react-hubspot-form locally, and modifying it slightly. See comment in `www/src/components/react-hubspot-form` for more info. * Fix `formInput` styles … now matching the reference homepage newsletter form — no more Futura PT for input text. * Return nothing because linter * Make into Two Words * Fix Comma Usage; Misc Updates (#13090) Hopefully fix a code formatting issue when in a highlighted section. * Fix Comma Usage; Misc Update (#13103) * chore: format
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
As part of the Learning task of improving core workflows, I'm taking a pass through the image and media docs due to the high number of related searches and Github issues. I've opened #12903 and I saw #8103 which referenced some of the stubs I either removed in this PR or will build out in the next few days. I removed two stubs as I felt they were already covered by existing docs, please chime in if you feel otherwise:
I added a new page for Working with Video, and added information to Importing Media Content. I kept them as stubs so that people would want to fill them out further, but I could be convinced otherwise.