Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move Learn Pulumi to Pulumi Tutorials #11883

Merged
merged 38 commits into from
Aug 8, 2024
Merged

Move Learn Pulumi to Pulumi Tutorials #11883

merged 38 commits into from
Aug 8, 2024

Conversation

cnunciato
Copy link
Contributor

@cnunciato cnunciato commented May 22, 2024

This change creates a new section called Pulumi Tutorials (🎉) and bootstraps it with content from Learn Pulumi. As part of this work, I also reviewed (and fixed!) all existing content and redirected all content from /learn to its new home at /tutorials.

A few things I've not yet done:

  • Documented how to create a new tutorial, how tutorials are sorted, grouped, sorted within a group, etc.

  • Added a make helper/Hugo archetype to simplify creating a new tutorial. We have these for Learn today and they're nice, but they don't map directly to the new stuff, so they'll need some adjusting.

  • Documented the concept of "collections" as it applies to tutorials. Everything here is a collection, and collections are typed -- so there are "provider" collections (e.g., aws), "proficiency" (i.e., skill-level) collections (pulumi-101), there'll surely be "product" and "feature" collections soon (ESC, Deployments, Components), etc. Collections are the only grouping mechanism we have, but the type field should make this pretty flexible (certainly flexible enough for now), and we can always extend/refactor the content model when/if we outgrow this. Tutorials can also belong to multiple collections, of course, or none, in which case they'll spill into the All Tutorials section on the Tutorials home page.

    Since there was so little content to go live with here, I created a single collection to start, and called it "Pulumi 101" (feel free to suggest an alternative -- I'm mainly looking for something succinct that conveys that these are meant for new users). It contains the first three Learn modules --- Fundamentals, Building, and Encapsulation, since those are all about core concepts (whereas Automation API and Importing are more advanced topics).

  • Written up authoring guidelines for tutorials -- what makes a good one, when to use multi-page vs. single-page, a general a structure to follow for both, etc.

  • Consolidated/figured out what to do with the "cloud engineering glossary". It does feel like there's a place for a glossary of sorts in this new section, so I'll probably find a way to integrate it somehow, but for now, it's got the same treatment it does today (and is redirected to /tutorials/glossary like everything else).

  • Made all the pre-reqs and intros consistent. I'll be doing that while y'all review what's here.

It may also feel like the navigation is a bit "sparse" right now, and that's mainly because we have so little content. As we add more tutorials, collections, and collection types, this will naturally grow and begin got look more like what we've been aiming for.

Fixes https://github.com/pulumi/devrel-team/issues/641
Fixes #12017
Fixes #10226
Fixes #10225
Fixes #12418
Fixes #10619
Fixes #10202
Fixes #10173
Fixes #10163
Fixes #10155
Fixes #11688
Fixes #12423
Fixes #12426

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@cnunciato cnunciato enabled auto-merge (squash) August 8, 2024 19:31
@cnunciato cnunciato merged commit 844c190 into master Aug 8, 2024
5 checks passed
@cnunciato cnunciato deleted the cnunciato/tutorials branch August 8, 2024 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment