We don't currently have any content on this page, and it's indexed, so we should probably send those who find it to our current Crosswalk for AWS docs.
* Prototyping new Swiftype search integration
* Remove script for building search index
* Remove search
* Script cleanup
* Style adjustments
* Relocate search bar to top of left nav
* Back out inadvertent package.json additions
* Reparent the Swiftype autocomplete container
Co-authored-by: Christian Nunciato <c@nunciato.org>
* Prefetch component.js files
* Use preload instead of prefetch
* Add crossorigin to preloads
* Use async instead of defer for component.js loads
* Add preloads for component scripts
* Use defer instead of async
* Apply suggestions from code review
Co-authored-by: Christian Nunciato <c@nunciato.org>
* Add back in crossorigin to avoid warning
* Update layouts/partials/head.html
Co-authored-by: Christian Nunciato <c@nunciato.org>
Co-authored-by: Christian Nunciato <c@nunciato.org>
* Add initial framework for event landing page
* Clean up event one pager and add new CTA
* Replace image with code block; update cta copy
* Update desktop cta and deploy block copy
* Update address to have google maps link
* Remove unused block and content
* Update naming convention for blocking crawlers from indexing a page
* Rename variable for excluding page from internal search
* Do not add pages blocked from external search to the site map
* Add follow to robots meta tag
* Update contributing doc with new front matter variable
* Remove external search blocking from docs index
* Rename event to show
* Move meta desc so pulumify can rebuild the preview
* Don't block on anchor.js
* Add “| Pulumi” to page titles
Signed-off-by: Christian Nunciato <c@nunciato.org>
* Honor shortened title tags where present
Signed-off-by: Christian Nunciato <c@nunciato.org>
* Fix link to example tutorial
Signed-off-by: Christian Nunciato <c@nunciato.org>
* Add H1 tags to pages without them
Signed-off-by: Christian Nunciato <c@nunciato.org>
* Reduce image sizes
Signed-off-by: Christian Nunciato <c@nunciato.org>
This change prefers meta_desc over summary for controlling meta
description tags.
It also undoes the check for a missing meta description in the
prior commit. Since we unconditionally use Hugo's auto content
summarization via .Summary, it doesn't do anything meaningful.
We may want to revisit this as part of pulumi/docs#1475.
This change fixes up some titles and meta descriptions, in hopes
that it'll have a positive impact on our SEO (and SERP summary).
- Ensure all pages have titles and meaningful meta descriptions.
- Error out if pages lack a meta description. Also add the ability
to write `nosummary: true` if it's intentionally omitted.
- I'd like to error out if pages lack a title too. Unfortunately,
the Python API docs are missing titles (pulumi/docs#1127), so this
check is not currently enabled (easy to uncomment out later).
I also made the possibly-controversial change to stop emitting an
automatic `- Pulumi` at the end of page titles. This
- Leads to illy things -- like `About Pulumi - Pulumi`.
- Might make it more difficult for Google to extract a good title for
our SERP summary; is that why "Documentation" is currently
awkwardly labeled simply "Pulumi" on Google at the moment?
- Probably has a net negative effect on things like blog articles,
which we would like to index naturally based on the content.
I propose that anywhere we want Pulumi in the title, we manually add it.
The `{{ else if ne .Summary "" }}` check is always evaluating to true (probably because `Summary` is typed as `template.HTML` instead of a `string` in Hugo's source), so we go down this path, but when then using `.Summary`, the value is empty. This results in many pages having empty `<meta name="description">` instead of falling back to using the default description. The fix is to check `{{ else if .Summary }}` which will only evaluate to true if `.Summary` is set and is a non-zero value.
While making changes here, I cleaned up how we access other params throughout. We'll often use `if isset .Params "foo"` to check if the `foo` param is set, but this only checks if the param is set -- it doesn't check if the param actually has a value. The fix is to just use `if .Params.foo`, which will only be true if `foo` is set and is not: `false` (boolean), `0` (integer), or a zero-length array, slice, map, or string.
Our use of PostCSS in Hugo requires the `postcss-cli` npm package to be installed. If it isn't, Hugo will print an error:
> PostCSS not found; install with "npm install postcss-cli". See https://gohugo.io/hugo-pipes/postcss/
However, this isn't ideal for us, as we use `yarn` in this repo, and don't use it directly. Instead, `make ensure` should be used.
My recent change to add a copy button to code snippets also depends on an npm package (`clipboard-polyfill`) to be installed. If it isn't, Hugo fails with several error messages about not being able to read the file, and it isn't immediately obvious how to address the issue.
This change makes it more clear how to address the problem. If the relevant directories do not exist in `node_modules`, we fail the Hugo build and print an error that says "Run `make ensure`".
