- Fix left alignment of "Edit on this Page" and "Request a Change"
- Remove "Edit on this Page" for generated pages
- Add "WARNING: this was generated by a tool" comment to generated pages
- Use Tailwind for styles
* Generalize `toc_nochildren` instead of looking for specific names
* Expandable/collapsable second level toc items
And cleanup the implementation while making changes here.
* Make CI/CD & SAML sub-pages true nav items
Now that we support expandable/collapsable second level nav items in the TOC, make the CI/CD and SAML sub pages true nav items, to match the nav items in Crosswalk.
* A very crude implementation of the glossary
No real styling has been applied yet, but the idea is you get a list of all the terms with anchor links to the definition and relevant documentation pages. Have to look into why it's not generating a right TOC for the H2 (my theory is because it is declared in the shortcode file rather than glossary.md?
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
Add sorting
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
Address feedback
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
Escape quotes
* Add initial list of terms
Add anchorize function
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
Remove duplicate entry
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Remove extra spaces
* Add initial list of terms
Add anchorize function
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
Remove duplicate entry
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Remove extra spaces
* Use 3 columns and other cleanup
- 3 columns for term index
- Use shortcode instead of `if` check in `single.html` layout
- Minor cleanup
* Address feedback
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Add a new property in the tutorial template to set the correct URL for the Deploy With Pulumi button.
* Regenerate tutorials.
* Detect Deploy With Pulumi button links and use its destination as the PulumiTemplateURL.
* New Home Page
Signed-off-by: Christian Nunciato <c@nunciato.org>
* Edit bits of the new homepage (#1665)
* Edit bits of the new homepage
This is a work in progress, however makes the following changes:
* Use a different heading/subheading.
* Make some fonts larger.
* Move the CTA above the fold and make it more prominent.
* Move Create/Deploy/Manage above the widget and style it differently.
* Change the text within Create/Deploy/Manage cards, and use
a bulleted headings style for the major points.
* Add a SVG header to the Manage card for symmetry -- although
it needs to be revised to include e.g. identity providers.
* Add real quotes.
* Add some new logos.
* Reorganize some non-homepage things
* Make the top navbar sticky -- and remove stickiness from some
of the other second level navbars that are less important now.
* Use bg-purple-900 rather than black in some places. The black
contrast just looks really retro and tacky to my eyes. (Honestly,
still could use some work here, but it's marginally less horrific.)
* Eliminate PRICING from the top nav. Our belief is too many people
click this and think we're 100% commercial without having open
source offerings. This page is still available, but is more deeply
integrated with the PRODUCT flow.
* Overhaul the PRODUCT page:
- Better top level messaging.
- Reuse the new carousel widget rather than the aging code snippet.
- Revamp all of the details below.
- Use slightly more modern looking FA icons rather than
the images we had before (which looked kind of random).
- Remove "Multi-Cloud Subscription" -- and add
"Support and Training."
- Link out to the PRICING page in certain key areas.
* Revamp overall message on the CAREERS page and massage some
margins and font sizes.
* Move WHY-PULUMI further to the right of the nav bar.
Sights set on revamping WHY-PULUMI next ...
* Revamp the Why, Pulumi page
* Remove some unused bits
* Tidy up partner, migrate, and topics pages
The partner, migrate, and topics pages are showing their age. At
some point (soon) we need to just blow them up and rewrite them with
our current voice and perspective. For the time being, I do know
they are helping with SEO, so I've done a pass over them to bring
them (roughly) up to code -- still not perfect, but much better.
* Rework titles and abstracts for all pages.
* Replace @pulumi/cloud* examples with modern equivalents.
* Direct to the general GET STARTED page in most places.
* Rewrite the how-pulumi-works partial to use HTML and our more
recent language and logos, instead of an aging screenshot.
* Ensure consistency on black 2nd level nav bars.
* Add partner logos for Azure and GCP.
* Use a real YouTube embed for the link to our video.
Fixes#1588.
* Refine the Why, Pulumi page further
* Make some more edits
...primarily to the "migrate" pages.
* Incorporate latest changes
Signed-off-by: Christian Nunciato <c@nunciato.org>
* Make final edits (#1683)
* Update the top level phrasing.
* Capitalize "Modern Infrastructure as Code" (it's bolder/stronger).
* Tweak some minor other language.
* Add a link to the video.
* Change carousel nav, tweak video, comment alert
* Make some adjustments for narrow mobiles
* Increase the Hugo timeout limit from 10 seconds to 30
This should mitigate the `timed out initializing value` for large API docs pages.
* Re-enable the broken link checker
* Fix broken links
Fix broken links that were introduced while the broken link checker was
temporarily disabled.
This change adds an OS chooser similar to what we have for languages.
This is then used for various installation pages to offer the end user
the ability to choose something other than the default that we've
detected -- in addition to making that choice sticky using cookies.
Most of the same code for the language chooser is refactored and
reused, although some of it had to remain specific to languages due
to the special case of hiding/showing code blocks.
Fixes#1394.
This change adds auto-generated tutorials, using our [examples repo](https://github.com/pulumi/examples) as its source. Namely, we scrape the README.mds. We do some on-the-fly rewriting of certain content to make it work on the docs website -- including adding appropriate links back to the GitHub source code -- however, for the most part, the content is taken as-is. There are plenty of examples that need to be tidied up for consistency, to make the titles better, and so on, but this seems like a significant overall improvement so we plan to land roughly as-is.
* Add auto-generated tutorials and indexes
* Update URLs to use new post-ToC update structure
* Add a Featured Tutorials section to AWS
* Add curated "Featured Tutorials" sections
* Remove numbers from tutorial titles
* Add links to the tutorials source code
* Remove "all tutorials" index
* Don't link to AKS from GCP tutorials page
* Add a VIEW CODE button
And also wordsmith some of the "get source code first" note.
* Use linktitle for shorter titles
This ensures that the navigation name and the breadcrumb match.
* Update text for requesting a new tutorial
* Add mktutorial to `make gen`
* Add a nicer tutorials landing page
* Simplify the VIEW CODE button
* Rewrite relative Markdown links
This change automatically rewrites Markdown links that are
relative to our GitHub repo, so that we don't end up with broken
links in the resulting documentation website.
* Fix some broken links
* Ignore some example links
Our examples contain a lot of illustrative links that are either
synthetic or not meant to be publicly accessed. Ignore them during
broken link checking.
* Add intro text and icons
Add shortcode for intro links
Clean up index page for Kubernetes cloud
Address feedback
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Add intro text and icons
Add shortcode for intro links
Clean up index page for Kubernetes cloud
Address feedback
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Clean up content
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Clean up crud
* Rebase
* Clean up content
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Add cloud intro shortcode
More text cleanup
Add suggested installation links for Python and Node.js (#1178)
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Update content/docs/quickstart/aws/create-project.md
Co-Authored-By: Justin Van Patten <jvp@justinvp.com>
* Address feedback
* Rebase
* Rebase continuation
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Fix indentation issue
* Remove crud
* Replace pulumi.com with Pulumi Service
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Move CI/CD docs under console/continuous-delivery
* Rename CI/CD docs
* Update references to new page locations
* Add CI/CD items to left-nav
* Migrate rest of Service docs
* Update a few more broken links
* Address PR feedback
* Add get started callout
First pass at informational note styling
Highlight Pulumi in headings and text for SEO purposes
Clean up home page
* Make a few little style tweaks
Lightens the background, adds a pixel border and uses a blue tint and underline for the link color as well.
Signed-off-by: Christian Nunciato <c@nunciato.org>
* Address feedback
Apply get-started-note shortcode to installation and tutorial index pages
Remove duplicate table of contents from Kubernetes tutorial
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Incorporate feedback and edits
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Clean up styles and add a warning note
Revert style change on single docs page layout
Address 1473
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Remove note around skipping version checks
* Clarify alternative installation options for all operating systems
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Change get-started button labels to “Get Started”
Signed-off-by: Christian Nunciato <c@nunciato.org>
* Remove the Why Pulumi button from the home page
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.
- Indent H3 items
- Provide a way to opt-out of showing "On This Page" and use it on some pages
- Only show "On This Page" if there are items in the list
- Added left padding to the right nav (to match the right padding on the left nav)
- General style and code cleanup
- Delete `mini-toc.html` partial
* Cleanup the Changelog
- Removed old entries that are being moved to the CHANGELOG.md in `pulumi/pulumi` repo.
- Remove "Changelog" from TOC. The "Download and Install" page links to this page at the bottom.
- Make the links in the table actually look like links.
- Added a `changelog-table-row` shortcode (replacing the `sdk-links` shortcode), which will make it easier to add new rows to the table without introducing subtle broken anchor links.
* Validate the content of the /static/latest-version file
While making related changes here, I've added a test that will ensure no trailing newlines (or other whitespace) is added to the `latest-version` file, which may break dependencies that aren't resilient to it. We recently saw this in a PR and luckily the broken link checker caught it, but this makes the test more explicit.
- Disabled for home but will need to be disabled for other content types
- Needs additional styling, plus consider making the navigation fixed
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
Update partial callout for right navigation
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
Moving the pages nested under Reference will take a lot of doing, so I took Luke's suggestion and have these items displayed by default. Changed the order around, merged supported clouds & languages, still a WIP
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
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.
