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.

Sign up for GitHub

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

Jump to bottom

Docs are generated with old Fn syntax #399

Open
iwahbe opened this issue Nov 4, 2022 · 0 comments
Open

Docs are generated with old Fn syntax #399

iwahbe opened this issue Nov 4, 2022 · 0 comments
Assignees
@aq17
Labels
area/docs Improvements or additions to documentation kind/bug Some behavior is incorrect or out of spec

Comments

@iwahbe
Copy link
Member

iwahbe commented Nov 4, 2022

What happened?

We are generating docs like https://www.pulumi.com/registry/packages/aws/api-docs/acmpca/getcertificate/:

variables:
  example:
    Fn::Invoke:
      Function: aws:acmpca:getCertificate
      Arguments:
        arn: arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/1234b4a0d73e2056789bdbe77d5b1a23
        certificateAuthorityArn: arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012

Steps to reproduce

Look at the documentation of any invoke.

Expected Behavior

Functions should be generated with the new camelCase syntax.

Actual Behavior

Functions are generated with the old CamelCase syntax.

Output of pulumi about

No response

Additional context

Issue was originally brought up via https://pulumi.slack.com/archives/C85BS3LJZ/p1667558918008279.

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).
@iwahbe iwahbe added kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team area/docs Improvements or additions to documentation and removed needs-triage Needs attention from the triage team labels Nov 4, 2022
@iwahbe iwahbe added this to the 0.80 milestone Nov 4, 2022
@aq17 aq17 mentioned this issue Nov 4, 2022
Merged
3 tasks
bors bot added a commit to pulumi/pulumi that referenced this issue Nov 4, 2022
@bors @aq17
Merge #11261
49fcc53 
11261: Update YAML invoke syntax for docs r=aq17 a=aq17

<!--- 
Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation.
-->

# Description

<!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. -->

Fixes pulumi-yaml pulumi/pulumi-yaml#399

## Checklist

<!--- Please provide details if the checkbox below is to be left unchecked. -->
- [ ] I have added tests that prove my fix is effective or that my feature works
<!--- 
User-facing changes require a CHANGELOG entry.
-->
- [ ] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change
<!--
If the change(s) in this PR is a modification of an existing call to the Pulumi Service,
then the service should honor older versions of the CLI where this change would not exist.
You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add
it to the service.
-->
- [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Service API version
  <!-- `@Pulumi` employees: If yes, you must submit corresponding changes in the service repo. -->


Co-authored-by: aq17 <aqiu@pulumi.com>
bors bot added a commit to pulumi/pulumi that referenced this issue Nov 4, 2022
@bors @aq17
Merge #11261
f7cd59a 
11261: Update YAML invoke syntax for docs r=aq17 a=aq17

<!--- 
Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation.
-->

# Description

<!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. -->

Fixes pulumi-yaml pulumi/pulumi-yaml#399

## Checklist

<!--- Please provide details if the checkbox below is to be left unchecked. -->
- [ ] I have added tests that prove my fix is effective or that my feature works
<!--- 
User-facing changes require a CHANGELOG entry.
-->
- [ ] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change
<!--
If the change(s) in this PR is a modification of an existing call to the Pulumi Service,
then the service should honor older versions of the CLI where this change would not exist.
You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add
it to the service.
-->
- [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Service API version
  <!-- `@Pulumi` employees: If yes, you must submit corresponding changes in the service repo. -->


Co-authored-by: aq17 <aqiu@pulumi.com>
bors bot added a commit to pulumi/pulumi that referenced this issue Nov 7, 2022
@bors @aq17
Merge #11261
2a98a6e 
11261: Update YAML invoke syntax for docs r=aq17 a=aq17

<!--- 
Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation.
-->

# Description

<!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. -->

Fixes pulumi-yaml pulumi/pulumi-yaml#399

## Checklist

<!--- Please provide details if the checkbox below is to be left unchecked. -->
- [ ] I have added tests that prove my fix is effective or that my feature works
<!--- 
User-facing changes require a CHANGELOG entry.
-->
- [ ] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change
<!--
If the change(s) in this PR is a modification of an existing call to the Pulumi Service,
then the service should honor older versions of the CLI where this change would not exist.
You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add
it to the service.
-->
- [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Service API version
  <!-- `@Pulumi` employees: If yes, you must submit corresponding changes in the service repo. -->


Co-authored-by: aq17 <aqiu@pulumi.com>
@mikhailshilkov mikhailshilkov modified the milestones: 0.80, 0.81 Nov 15, 2022
@AaronFriel AaronFriel modified the milestones: 0.81, 0.82 Dec 6, 2022
@aq17 aq17 mentioned this issue Dec 7, 2022
Merged
@lukehoban lukehoban modified the milestones: 0.82, 0.83 Jan 13, 2023
@mikhailshilkov mikhailshilkov modified the milestones: 0.83, 0.84 Jan 27, 2023
@lukehoban lukehoban modified the milestones: 0.84, 0.85 Feb 14, 2023
@mikhailshilkov mikhailshilkov removed this from the 0.85 milestone Apr 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aq17 aq17

Labels
area/docs Improvements or additions to documentation kind/bug Some behavior is incorrect or out of spec
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@lukehoban @AaronFriel @mikhailshilkov @iwahbe @aq17