😅

pulumi · Aug 8, 2024 · ba74840 · ba74840
1 parent 30e18ae
commit ba74840
Show file tree

Hide file tree

Showing 30 changed files with 337 additions and 448 deletions.
diff --git a/README.md b/README.md
@@ -85,7 +85,7 @@ The `Makefile` exposes a number of useful helpers for authoring:
 * `make new-blog-post` scaffolds a new, bare-bones blog post with placeholder content
 * `make new-tutorial` scaffolds a new single-page tutorial
 * `make new-tutorial-module` scaffolds a new multi-page tutorial
-* `make new-tutorial-topic` scaffolds a new tutorial topic and adds to an existing tutorial
+* `make new-tutorial-topic` scaffolds a new tutorial topic and adds it to an existing multi-page tutorial
 * `make new-example-program` generates a new multi-language set of examples at `./static/programs`
 * `make new-dev-stack` creates a new dev stack (in the `pulumi` organization, which you must belong to)
 * `make deploy-dev-stack` runs a build, deploys to S3, runs the tests, and deploys to the selected dev stack

diff --git a/archetypes/tutorials/module/_index.md b/archetypes/tutorials/module/_index.md
@@ -12,28 +12,28 @@ meta_desc: Here is a brief description of what this module's all about.
 # An image for the tutorial. It appears on the module index page and in social-media previews.
 meta_image: meta.png
 
-# The order in which the module appears on the Tutorials home page. Order is ascending, so higher numbers
+# The order in which the module appears in most lists. Order is ascending, so higher numbers
 # mean the module will appear further down the list. Positive integers only.
 weight: 999
 
-# A brief summary of the module. It appears at the top of the module-index page. Markdown is acceptable.
+# A brief summary of the module. It appears at the top of the module-index page. Markdown is fine.
 summary: |
     This is the module summary. It should describe the overall goal of the module and briefly cover what
     the reader will know how to do by the end of it.
 
 # A list of three to five things the reader will have learned by the end of the tutorial.
 youll_learn:
-    - How to do things
-    - When to do things (and when not to)
-    - Why it's better to do some things and not others
+    - How to do X
+    - When to do Y
+    - Why X is more preferable than Y
 
-# A list of tutorial prerequisites. Markdown is acceptable. Keep it simple; no need to be exhaustive here.
+# A list of tutorial prerequisites. Markdown is fine. Keep it simple; no need to be exhaustive here.
 prereqs:
     - The [Pulumi CLI](/docs/install/)
     - A [Pulumi Cloud account](https://app.pulumi.com/signup) and [access token](/docs/pulumi-cloud/accounts/#access-tokens)
     - Familiarity with JavaScript, TypeScript, or Python
 
-# An optional list of collections that should include this tutorial. Collections are defined in data/tutorials/collections.yaml.
+# An optional list of collections this tutorial should be belong to. Collections are defined in data/tutorials/collections.yaml.
 collections:
-    - some-collection
+    - some-non-existent-collection
 ---
diff --git a/archetypes/tutorials/single/index.md b/archetypes/tutorials/single/index.md
@@ -4,30 +4,30 @@ title_tag: "{{ replace .Name "-" " " | title }}"
 layout: single
 
 # A succinct description of the tutorial. It appears on the Tutorials home and collection pages.
-description: Here is a brief description of what this module's all about.
+description: Here is a brief description of what this tutorial's all about.
 
 # A similar description used for search results and social-media previews.
-meta_desc: Here is a brief description of what this module's all about.
+meta_desc: Here is a brief description of what this tutorial's all about.
 
-# An image for the tutorial. It appears on the module index page and in social-media previews.
+# An image for the tutorial. It appears on tutorial page and in social-media previews.
 meta_image: meta.png
 
-# The order in which the module appears on the Tutorials home page. Order is ascending, so higher numbers
-# mean the module will appear further down the list. Positive integers only.
+# The order in which the tutorial appears in most lists. Order is ascending, so higher numbers
+# mean the tutorial will appear further down the list. Positive integers only.
 weight: 999
 
-# A brief summary of the module. It appears at the top of the module-index page. Markdown is acceptable.
+# A brief summary of the tutorial. It appears at the top of the tutorial page. Markdown is fine.
 summary: |
-    This is the module summary. It should describe the overall goal of the module and briefly cover what
+    This is the tutorial summary. It should describe the overall goal of the tutorial and briefly cover what
     the reader will know how to do by the end of it.
 
 # A list of three to five things the reader will have learned by the end of the tutorial.
 youll_learn:
-    - How to do things
-    - When to do things (and when not to)
-    - Why it's better to do some things and not others
+    - How to do X
+    - When to do Y
+    - Why X is more preferable than Y
 
-# A list of tutorial prerequisites. Markdown is acceptable. Keep it simple; no need to be exhaustive here.
+# A list of tutorial prerequisites. Markdown is fine. Keep it simple; no need to be exhaustive here.
 prereqs:
     - The [Pulumi CLI](/docs/install/)
     - A [Pulumi Cloud account](https://app.pulumi.com/signup) and [access token](/docs/pulumi-cloud/accounts/#access-tokens)
@@ -36,9 +36,9 @@ prereqs:
 # The estimated time, in minutes, for new users to complete the topic.
 estimated_time: 10
 
-# An optional list of collections that should include this tutorial. Collections are defined in data/tutorials/collections.yaml.
+# An optional list of collections this tutorial should be belong to. Collections are defined in data/tutorials/collections.yaml.
 collections:
-    - some-collection
+    - some-non-existent-collection
 ---
 
 This is the actual content of the tutorial.
diff --git a/archetypes/tutorials/topic/index.md b/archetypes/tutorials/topic/index.md
@@ -12,8 +12,8 @@ meta_desc: Here is a brief description of this topic.
 # An optional image for this topic. It appears at the top of the page and is used in social-media previews.
 meta_image: meta.png
 
-# The order in which the module appears on the Tutorials home page. Order is ascending, so higher numbers
-# mean the module will appear further down the list. Positive integers only.
+# The order in which the topic appears in most lists. Order is ascending, so higher numbers
+# mean the topic will appear further down the list. Positive integers only.
 weight: 999
 
 # The estimated time, in minutes, for new users to complete the topic.

diff --git a/assets/css/bundle.css b/assets/css/bundle.css
diff --git a/assets/css/marketing.css b/assets/css/marketing.css
@@ -1,6 +1,3 @@
-/*!*********************************************************************************************************************************************************************************************************************!*\
-  !*** css ./node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[1].use[1]!./node_modules/postcss-loader/dist/cjs.js!./node_modules/sass-loader/dist/cjs.js??ruleSet[1].rules[1].use[3]!./src/scss/_marketing.scss ***!
-  \*********************************************************************************************************************************************************************************************************************/
 /*! tailwindcss v2.2.15 | MIT License | https://tailwindcss.com */
 
 /*! modern-normalize v1.1.0 | MIT License | https://github.com/sindresorhus/modern-normalize */

diff --git a/assets/js/bundle.js b/assets/js/bundle.js
diff --git a/assets/js/marketing.js b/assets/js/marketing.js
@@ -1 +0,0 @@
-(()=>{"use strict";var __webpack_modules__={"./src/scss/_marketing.scss":(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack://theme/./src/scss/_marketing.scss?")},"./src/ts/marketing.ts":(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{eval('__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _scss_marketing_scss__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../scss/_marketing.scss */ "./src/scss/_marketing.scss");\n\n\n\n//# sourceURL=webpack://theme/./src/ts/marketing.ts?')}},__webpack_module_cache__={};function __webpack_require__(_){var e=__webpack_module_cache__[_];if(void 0!==e)return e.exports;var r=__webpack_module_cache__[_]={exports:{}};return __webpack_modules__[_](r,r.exports,__webpack_require__),r.exports}__webpack_require__.r=_=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(_,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(_,"__esModule",{value:!0})};var __webpack_exports__=__webpack_require__("./src/ts/marketing.ts")})();

diff --git a/content/tutorials/abstraction-encapsulation/_index.md b/content/tutorials/abstraction-encapsulation/_index.md
@@ -19,7 +19,7 @@ prereqs:
     - Familiarity with JavaScript, TypeScript, or Python
     - A [Docker](https://docs.docker.com/get-docker/) service installed and running locally
 collections:
-    - pulumi-101
+    - learn-pulumi
 collections_weight: 3
 aliases:
     - /learn/abstraction-encapsulation/

diff --git a/content/tutorials/building-with-pulumi/_index.md b/content/tutorials/building-with-pulumi/_index.md
@@ -20,7 +20,7 @@ prereqs:
     - Familiarity with JavaScript, TypeScript, or Python
     - A [Docker](https://docs.docker.com/get-docker/) service installed and running locally
 collections:
-    - pulumi-101
+    - learn-pulumi
 collections_weight: 2
 aliases:
     - /learn/building-with-pulumi/

diff --git a/content/tutorials/pulumi-fundamentals/_index.md b/content/tutorials/pulumi-fundamentals/_index.md
@@ -22,7 +22,7 @@ prereqs:
     - Familiarity with JavaScript, TypeScript, or Python
     - A [Docker](https://docs.docker.com/get-docker/) service installed and running locally
 collections:
-    - pulumi-101
+    - learn-pulumi
 collections_weight: 1
 aliases:
     - /learn/pulumi-fundamentals/

diff --git a/data/tutorials/collections.yaml b/data/tutorials/collections.yaml
@@ -33,7 +33,7 @@
   logo: /logos/pkg/aws.svg
   featured: false
 
-- id: pulumi-101
+- id: learn-pulumi
   type: proficiency
-  name: The Basics
-  description: A collection of tutorials to help you learn core Pulumi concepts.
+  name: Learn Pulumi
+  description: Intro-level walkthroughs to help you learn core Pulumi infrastructure-as-code concepts.
diff --git a/layouts/partials/assets.html b/layouts/partials/assets.html
@@ -20,8 +20,8 @@
 {{ if in $nonMarketingSections .Section }}
 {{ else }}
     {{ $marketingCss := resources.Get "css/marketing.css" | fingerprint }}
-    <link rel="stylesheet" href="{{ $marketingCss.RelPermalink }}"></link>
+    <link rel="stylesheet" href="{{ $marketingCss.RelPermalink }}">
 {{ end }}
 
 {{ $css := resources.Get "css/bundle.css" | fingerprint }}
-<link rel="stylesheet" href="{{ $css.RelPermalink }}"></link>
+<link rel="stylesheet" href="{{ $css.RelPermalink }}">
diff --git a/layouts/partials/docs/search.html b/layouts/partials/docs/search.html
@@ -1,46 +1,48 @@
 <div class="docs-type-nav-search">
     <div class="docs-type-nav">
-        {{ $mode := .Scratch.Get "mode" }}
-        {{ if eq "docs" $mode }}
-            <a class="tab-selected" href="/docs/">
-                <img class="tab-icon" src="/icons/docs.svg" />
-                <span>Docs</span>
-            </a>
-            <a class="tab" href="/registry/">
-                <img class="tab-icon" src="/icons/registry-light.svg" />
-                <span>Packages</span>
-            </a>
-            <a class="tab" href="/tutorials/">
-                <img class="tab-icon" src="/icons/graduation-cap.svg" />
-                <span>Tutorials</span>
-            </a>
-        {{ else if (or (eq "tutorials" $mode) (eq "providers" $mode) (eq "collections" $mode)) }}
-            <a class="tab" href="/docs/">
-                <img class="tab-icon" src="/icons/docs.svg" />
-                <span>Docs</span>
-            </a>
-            <a class="tab" href="/registry/">
-                <img class="tab-icon" src="/icons/registry-light.svg" />
-                <span>Packages</span>
-            </a>
-            <a class="tab-selected" href="/tutorials/">
-                <img class="tab-icon" src="/icons/graduation-cap.svg" />
-                <span>Tutorials</span>
-            </a>
-        {{ else }}
-            <a class="tab" href="/docs/">
-                <img class="tab-icon" src="/icons/docs-light.svg" />
-                <span>Docs</span>
-            </a>
-            <a class="tab-selected" href="/registry/">
-                <img class="tab-icon" src="/icons/registry.svg" />
-                <span>Packages</span>
-            </a>
-            <a class="tab" href="/tutorials/">
-                <img class="tab-icon" src="/icons/graduation-cap.svg" />
-                <span>Tutorials</span>
-            </a>
-        {{ end }}
+        <div class="inline-flex items-center">
+            {{ $mode := .Scratch.Get "mode" }}
+            {{ if eq "docs" $mode }}
+                <a class="tab-selected" href="/docs/">
+                    <img class="tab-icon" src="/icons/docs.svg" />
+                    <span>Docs</span>
+                </a>
+                <a class="tab" href="/registry/">
+                    <img class="tab-icon" src="/icons/registry-light.svg" />
+                    <span>Packages</span>
+                </a>
+                <a class="tab" href="/tutorials/">
+                    <img class="tab-icon" src="/icons/graduation-cap.svg" />
+                    <span>Tutorials</span>
+                </a>
+            {{ else if (or (eq "tutorials" $mode) (eq "providers" $mode) (eq "collections" $mode)) }}
+                <a class="tab" href="/docs/">
+                    <img class="tab-icon" src="/icons/docs.svg" />
+                    <span>Docs</span>
+                </a>
+                <a class="tab" href="/registry/">
+                    <img class="tab-icon" src="/icons/registry-light.svg" />
+                    <span>Packages</span>
+                </a>
+                <a class="tab-selected" href="/tutorials/">
+                    <img class="tab-icon" src="/icons/graduation-cap.svg" />
+                    <span>Tutorials</span>
+                </a>
+            {{ else }}
+                <a class="tab" href="/docs/">
+                    <img class="tab-icon" src="/icons/docs-light.svg" />
+                    <span>Docs</span>
+                </a>
+                <a class="tab-selected" href="/registry/">
+                    <img class="tab-icon" src="/icons/registry.svg" />
+                    <span>Packages</span>
+                </a>
+                <a class="tab" href="/tutorials/">
+                    <img class="tab-icon" src="/icons/graduation-cap.svg" />
+                    <span>Tutorials</span>
+                </a>
+            {{ end }}
+        </div>
     </div>
     <div class="docs-search">
         <div

diff --git a/layouts/partials/header.html b/layouts/partials/header.html
@@ -461,15 +461,14 @@
                                         <a href="/resources#upcoming"> <i class="fas fa-users fa-fw"></i> Events and Workshops </a>
                                     </li>
                                     <li>
-                                        <a href="/templates/">
-                                            <span> <img src="/icons/square-foot.svg" class="inline h-8 opacity-90" /> </span>Templates
+                                        <a href="/templates/"><span> <img src="/icons/square-foot.svg" class="inline h-8 opacity-90" /> </span>Templates
                                         </a>
                                     </li>
                                     <li>
                                         <a href="/ai/answers"> <i class="fas fa-robot mr-0.5"></i> Pulumi AI Answers </a>
                                     </li>
                                     <li>
-                                        <a href="/learn/"> <i class="fas fa-chalkboard-teacher fa-fw"></i> Learn Pulumi </a>
+                                        <a href="/learn/"> <i class="fas fa-chalkboard-teacher fa-fw"></i> Tutorials </a>
                                     </li>
                                     <li>
                                         <a href="/community/"> <i class="fas fa-users fa-fw"></i> Community </a>

diff --git a/layouts/partials/tutorials/feedback.html b/layouts/partials/tutorials/feedback.html
@@ -0,0 +1,47 @@
+<div id="docsFeedbackContainer" class="hidden pl-2 text-xs text-gray-600">
+    <div id="feedbackButtons">
+        <p class="my-4">Was this page helpful?</p>
+        <div class="flex items-center">
+            <a id="docsFeedbackYes" data-track="feedback-yes" class="flex items-center cursor-pointer hover:text-gray-700">
+                <i class="fas fa-thumbs-up mr-2"></i>
+                <span> Yes </span>
+            </a>
+            <a id="docsFeedbackNo" data-track="feedback-no" class="flex items-center cursor-pointer ml-4 hover:text-gray-700">
+                <i class="fas fa-thumbs-down mr-2"></i>
+                <span> No </span>
+            </a>
+        </div>
+    </div>
+    <div id="feedbackThankYou" class="hidden">
+        {{ $problemTitle := printf "Issue with %s" .Permalink }}
+        {{ $improvementTitle := printf "Improvement for %s" .Permalink }}
+        <p>Thank you for your feedback!</p>
+        <p>If you have a question about how to use Pulumi, reach out in <a href="https://slack.pulumi.com/">Community Slack</a>.</p>
+        <p>
+            Open an issue on GitHub to
+            <a href="https://github.com/pulumi/docs/issues/new?title={{ $problemTitle }}">report a problem</a> or
+            <a href="https://github.com/pulumi/docs/issues/new?title={{ $improvementTitle }}">suggest an improvement</a>.
+        </p>
+    </div>
+    <div id="feedbackLongForm" class="hidden text-gray-700 text-sm">
+        <div class="popup-overlay">
+            <div class="bg-white m-auto w-10/12 md:w-5/12 rounded overflow-hidden">
+                <div class="mx-5 pt-4 flex relative">
+                    <p class="inline-block m-0 text-3xl">Feedback</p>
+                </div>
+                <div class="p-5 pt-0">
+                    <p>Thank you for your feedback! If you would like to provide additional feedback, please let us know your thoughts below.</p>
+                    <textarea
+                        id="feedbackAdditionalComments"
+                        rows="5"
+                        class="mb-3 w-full p-2 bg-white rounded border border-gray-500 outline-none"
+                        placeholder="Additional Comments"
+                    ></textarea>
+                    <input id="feedbackEmail" type="email" class="block mb-4 w-full p-2 rounded border border-gray-500 outline-none" placeholder="Email (optional)" />
+                    <a id="docsSubmitFeedback" class="btn md:w-1/4 mb-3 text-center block md:inline-block">Submit</a>
+                    <a id="docsCloseFeedbackLongForm" class="cursor-pointer md:inline-block md:w-1/4 text-center block">Close</a>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
diff --git a/layouts/partials/tutorials/right-nav-ad.html b/layouts/partials/tutorials/right-nav-ad.html
@@ -0,0 +1,5 @@
+<div class="mt-8 docs-marketing-ad w-44">
+    <a href="/pulumi-up" data-track="docs-pulumiup-ad">
+        <img src="/images/docs/ad/pulumiup-ad.gif" alt="PulumiUP - September 18, 2024. Register Now." />
+    </a>
+</div>
diff --git a/layouts/partials/tutorials/topic-links.html b/layouts/partials/tutorials/topic-links.html
diff --git a/layouts/partials/tutorials/topics-next-prev.html b/layouts/partials/tutorials/topics-next-prev.html
Original file line number	Diff line number	Diff line change
		@@ -1 +0,0 @@
		(()=>{"use strict";var __webpack_modules__={"./src/scss/_marketing.scss":(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack://theme/./src/scss/_marketing.scss?")},"./src/ts/marketing.ts":(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{eval('__webpack_require__.r(__webpack_exports__);\n/* harmony import / var _scss_marketing_scss__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/! ../scss/_marketing.scss */ "./src/scss/_marketing.scss");\n\n\n\n//# sourceURL=webpack://theme/./src/ts/marketing.ts?')}},__webpack_module_cache__={};function __webpack_require__(_){var e=__webpack_module_cache__[_];if(void 0!==e)return e.exports;var r=__webpack_module_cache__[_]={exports:{}};return __webpack_modules__[_](r,r.exports,__webpack_require__),r.exports}__webpack_require__.r=_=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(_,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(_,"__esModule",{value:!0})};var __webpack_exports__=__webpack_require__("./src/ts/marketing.ts")})();