readme updates #1649
readme updates #1649
Conversation
README.md
Outdated
|
|
||
| **Pulumi's Infrastructure as Code SDK** is the easiest way to build and deploy infrastructure, of any architecture and on any cloud, using programming languages that you already know and love. Code and ship infrastructure faster with your favorite languages and tools, and embed IaC anywhere with [Automation API](https://www.pulumi.com/docs/guides/automation-api/?utm_campaign=pulumi-examples-github-repo&utm_source=github.com&utm_medium=about-pulumi). | ||
|
|
||
| Pulumi is open source under the [Apache 2.0 license](https://github.com/pulumi/pulumi/blob/master/LICENSE), supports many languages and clouds, and is easy to extend. This repo contains the `pulumi` CLI, language SDKs, and core Pulumi engine, and individual libraries are in their own repos. |
There was a problem hiding this comment.
We should probably tweak this, as this repo doesn't contain these things.
README.md
Outdated
| Don't see an example listed? [Try Pulumi AI](https://www.pulumi.com/ai) and use natural-language prompts to generate Pulumi infrastructure-as-code programs in _any_ language. | ||
| Don't see an example listed? [Try Pulumi Copilot](https://app.pulumi.com/?utm_campaign=pulumi-examples-github-repo&utm_source=github.com&utm_medium=pulumi-examples) and use natural-language prompts to generate Pulumi infrastructure-as-code programs in _any_ language. |
There was a problem hiding this comment.
FWIW, most users who navigate to this URL won't see an indication of Copilot on the page -- at least not as of today. (It only shows up if you belong to an org and your org admin has enabled it.) So most people who click this link will end up confused as to what to do next, as it'll look like a dead end. Should we just leave this as-is until we have a destination for those folks?
Edit: I see we've put these links throughout the README. I'm not sure this is a great idea actually, since Copilot isn't available to individual users. So we'll be sending people to a page requiring sign-in that won't deliver what we've promised. Almost surely a better experience to have this point to Pulumi AI for now in that regard.
README.md
Outdated
| [(Click here to go back to the main list)](#outline) | ||
| [(Click here to go back to the library)](#example-library) | ||
|
|
||
| [Try Pulumi Copilot](https://app.pulumi.com/?utm_campaign=pulumi-examples-github-repo&utm_source=github.com&utm_medium=pulumi-examples) and use natural-language prompts to generate Pulumi example programs in _any_ language. |
There was a problem hiding this comment.
This generally feels repetitive and advertising-y/spammy to me.
I'd suggest cutting it back a bit and putting these at the end of each list with something like "Don't see what you're looking for? [Try Pulumi AI]" and then leaving it at that, as users will almost surely be able to gather from context what to expect when they click that.
README.md
Outdated
| - [Get Started with Pulumi](https://www.pulumi.com/docs/get-started/?utm_campaign=pulumi-examples-github-repo&utm_source=github.com&utm_medium=examples-resources): Deploy a simple application in AWS, Azure, Google Cloud, or Kubernetes using Pulumi. | ||
| - [Registry](https://www.pulumi.com/registry/?utm_campaign=pulumi-examples-github-repo&utm_source=github.com&utm_medium=examples-resources): Search for packages and learn about the supported resources you need. Install the package directly into your project, browse the API documentation, and start building. | ||
| - [Try Pulumi AI](https://www.pulumi.com/ai/?utm_campaign=pulumi-examples-github-repo&utm_source=github.com&utm_medium=examples-resources) - Use natural-language prompts to generate Pulumi infrastructure-as-code programs in any language. | ||
| - [Documentation](https://www.pulumi.com/docs/?utm_campaign=pulumi-examples-github-repo&utm_source=github.com&utm_medium=examples-resources): Learn about Pulumi concepts, follow user guides, and consult the reference documentation. | ||
| - [Pulumi Blog](https://www.pulumi.com/blog/?utm_campaign=pulumi-examples-github-repo&utm_source=github.com&utm_medium=examples-resources) - Stay in the loop with our latest tech announcements, insightful articles, and updates. |
There was a problem hiding this comment.
Bit of a nit, but I'd probably reorder these by likely relevance:
- Get started
- Docs
- Blog
- Registry
- AI
README.md
Outdated
|
|
||
| ## Table of contents | ||
|
|
||
| - :rocket: [Pulumi Examples](#pulumi-examples) |
There was a problem hiding this comment.
Looking at this list of items, I have a few questions:
- How are the first two different? The first one is the name of this repo -- so does that mean the second will take me somewhere else? If so, where to?
- Will the Community link take me somewhere else (like "to the Pulumi community")? If not, should it say something like "Pulumi Community resources", and maybe be sorted listed alongside Pulumi resources?
- Should we include a link to the FAQs in this TOC also, since it's a sibling of these other headings?
- Should the contributing FAQ item be a heading of its own, since it's specific to this repo?
- Is Roadmap not a resource? What would I expect to see under Pulumi Resources, given the other items in this list? (I'm actually not sure, until I click.)
- Should the repo-specific items be grouped together somehow, and the other items listed below them? For example, the first two links and the Contributors link are all related to this repo, but none of the other links are; they all seem to link off to destinations outside this repo. It makes the info feel less organized and clear to me than it probably should.
Sorry for what may seem like nits -- just figured that if we're planning to propagate this overall structure to other repos as I think we are, we should probably tighten things up a bit.
Co-authored-by: Christian Nunciato <[email protected]>
Co-authored-by: Christian Nunciato <[email protected]>
Co-authored-by: Christian Nunciato <[email protected]>
Co-authored-by: Christian Nunciato <[email protected]>
🚀
Updates to examples readme: