3 Commits

Author SHA1 Message Date
Christian Nunciato
06afa6d1a0
Redirect /crosswalk (#1024)
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.
2022-02-02 10:30:23 -08:00
Zack Chase
5ab3d65926 Add markdown linting (#2135)
* Add markdown linting script; fix markdown lint errors

* Add support for meta description and page title validation

* Add comments

* Fix lint errors; exclude autogenerated tutorials

* Address feedback; add more comments

* Add more checks for redirect pages; no index; and auto generated content

* More fixes for lint errors

* Allow duplicate headings in a page

* More lint error fixes

* Even more lint error fixes

* Getting started guide lint fixes

* Add custom h1 support to docs single pages

* Use custom h1 tags on cloud getting started guides

* Add custom h1 support to docs

* Add custom h1 support to docs lists.html

* Final round of intial lint fixes

* Add markdown linting to build script

* Update README

* Test build failure due to lint error

* Fix lint error so build will pass

* Readability fixes for lint script
2019-12-18 09:59:20 -08:00
joeduffy
9da560dc98 Fix some titles and meta descriptions
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.
2019-07-30 11:33:36 -04:00