-
Notifications
You must be signed in to change notification settings - Fork 245
Restructure Functions documentation as top-level concept #15440
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
Conversation
Your site preview for commit 0f4c6c5 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-15440-0f4c6c52.s3-website.us-west-2.amazonaws.com. |
- Create new Functions overview page explaining three function types - Move provider functions from resources section to functions section - Move get functions from resources section to functions section - Extract resource methods into separate page - Remove JavaScript example from get functions page - Update navigation structure and menu weights Addresses GitHub issue #15438 by elevating Functions from a sub-page of Resources to a top-level concept in the documentation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
0f4c6c5
to
30a1bb5
Compare
Your site preview for commit 30a1bb5 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-15440-30a1bb5c.s3-website.us-west-2.amazonaws.com. |
Your site preview for commit b9f3c09 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-15440-b9f3c09e.s3-website.us-west-2.amazonaws.com. |
|
||
## Get functions | ||
|
||
**[Get functions](/docs/iac/concepts/functions/get-functions/)** are static functions available on all Pulumi resource types that allow you to reference an existing resource that is not managed by Pulumi. Unlike the `pulumi import` command which brings resources under Pulumi management, get functions simply allow you to read the properties of existing resources. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrasing is a bit language specific. In Go, they are just free-standing functions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Y'know... I did struggle with this. I originally wanted to put the examples of each type in every language, but I could not get the dang invokes to fit on one line.
Added a note for the future: #15457
|
||
## Resource methods | ||
|
||
**[Resource methods](/docs/iac/concepts/functions/resource-methods/)** are functions attached to specific resource types that return computed values from resources you are managing with Pulumi. These methods are called on resource instances and typically provide additional derived information about that resource. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These functions could also create arbitrary resources. Why do they need to be just computed values.
Fixes #15438
🤖 Generated with Claude Code