* Use next page title as the button in Getting Started
This changes the "NEXT STEP >" button to use the title of the
next page in the flow, like "INSTALL PULUMI >", etc. The theory
is that this is more enticing to click as well as clearly
communicating what comes next.
As part of this, I changed the "CONFIGURE >" step to be a little
clearer; for now, I chose "CONFIGURE CLOUD ACCESS >" for AWS,
Azure, and GCP, and "CONFIGURE CLUSTER ACCESS >" for Kubernetes.
* Change Configure X buttons
* Defer call glog.Flush in tools/resourcedocsgen.
* Allow passing a provider name to scripts/gen_resource_docs.sh.
* Don't use markdownify in the inner example shortcode.
* Use master branch of provider repos instead of calling update_repos.sh temporarily.
* Regen GCP resource docs with master.
* Regen Azure AD resource docs with master.
* Regen Azure resource docs with master.
* Regen AWS resource docs with master.
* Do an editorial pass over programming model docs
This is an editorial pass over the programming model docs, as part
of #1618. This includes rearranging ordering to minimize forward
references, getting rid of anything that smells "TypeScript-only",
restructuring headers so the ToC is a bit more structured,
wordsmithing, fleshing out examples, and trying to simplify the
presentation of content -- while also embellishing where it helps.
This is not done. The Go and TypeScript pages are empty. There is
still quite a number of TypeScript-only hyperlinks and terminology.
* Add Vim swp files to gitignore
* Use shortcodes to cut down on language-specific text/links
This change adds some shortcodes for common language-specific
text and associated links.
For instance, outputs are Output in JS, Output<T> in TS,
Output[T] in Python, Output in Go, and Output<T> in C#, and go
to very different places hyperlink-wise.
Because of the way our language switcher JavaScript works, we
display the JS version by default until it kicks in and picks
up the user's choice. This avoids awkward flashes in which all
or none of the options are available or missing.
I'm not done applying this to all possible codes, but at least
it lays the foundation to start paying down this debt.
* Fix a couple hygiene issues
* Clarify conditional execution of apply
* Fix input shortcode
* Add shortcodes for most language-specific things
This eliminates most (all?) of the language-specific texts and
links in the programming model document, replaced with shortcodes.
* Fix up some loose ends
* Add Go language page and Get Started guides
* Fix linter errors
* Apply suggestions from code review
Co-Authored-By: Christian Nunciato <c@nunciato.org>
* Apply additional code review feedback
* Use spaces, not tabs.
* Use tailwind styles, not inline CSS.
Co-authored-by: Christian Nunciato <christian@pulumi.com>
* Add link linter script
* Add build commands for linting links
* Add linting to start of serve script
* Add tracking ids to links
* Add tracking id to links
* Finish adding tracking ids to remaining html links
* Add front labels to lint results
* Add some checks to function inputs; address feedback
* Add checks that the element exists before sending tracking event
* Add urlize to dynamically created tracking ids
* Switch to generating ids instead of hardcoding
* Do not encode strings when generating link tracking ids
* Convert to use data-track attribute instead of data-tracking-id
* Remove link linter
* Fix duplicate read more tag
* Revert breadcrumb html to be one line to eliminate extra space
* Remove unused package
* Update g suite name convention on tracking id
Co-Authored-By: Christian Nunciato <c@nunciato.org>
Co-authored-by: Christian Nunciato <christian@pulumi.com>
* Add shortcode for summary
Update cleanup shortcode
Update Containers on Fargate tutorial
Update webserver tutorial to use shortcode
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Clean up REST API tutorial
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Fix broken link and remove extra spaces
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Final featured tutorial cleanup for AWS
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Fix 1640
* Address PR feedback
Co-Authored-By: Justin Van Patten <jvp@justinvp.com>
Co-Authored-By: Eric Rudder <ericrudder@users.noreply.github.com>
Co-Authored-By: Christian Nunciato <christian@pulumi.com>
* Clean up EC2 webserver tutorial
Add shortcode for multi-language prerequisites
Add shortcode for GitHub buttons for multi-language examples
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Pull in tutorial title updates
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Clean up EC2 webserver tutorial
Signed-off-by: bermudezmt <bermudez.mt@gmail.com>
* Fix broken link
- Use ungreedy matches for links.
- Don't attempt to fix-up links that start with "../"
- 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
* 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.
* 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>
