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

Add Example documentation for Image #479

Merged
merged 13 commits into from
Feb 3, 2023
Merged

Add Example documentation for Image #479

merged 13 commits into from
Feb 3, 2023

Conversation

guineveresaenger
Copy link
Contributor

This PR uses code similar to pulumi/pulumi-kubernetes#1999
to generate valid code blocks to use as an example for the use of the Image resource.

Fixes #406
Supersedes #440

  • Add code to generate documentation to provider package
  • Add examplegen as a Makefile step
  • Add Java
  • Embed Example Usage doc into Image Resource
  • Fix Java example and regenerate schema
  • Generate SDKs

@github-actions
Copy link

github-actions bot commented Feb 3, 2023

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

@guineveresaenger guineveresaenger requested a review from a team February 3, 2023 00:45
Copy link
Member

@iwahbe iwahbe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The examples look great.

I have a couple nits for the implementation that should be addressed before merging.

Makefile Outdated
.PHONY: development build build_sdks examples install_go_sdk install_java_sdk install_python_sdk install_sdks only_build build_dotnet build_go build_java build_nodejs build_python clean cleanup help install_dotnet_sdk install_nodejs_sdk install_plugins lint_provider provider test tfgen
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just so diffs become meaningful (assuming we are now editing this file by hand.

Suggested change
.PHONY: development build build_sdks examples install_go_sdk install_java_sdk install_python_sdk install_sdks only_build build_dotnet build_go build_java build_nodejs build_python clean cleanup help install_dotnet_sdk install_nodejs_sdk install_plugins lint_provider provider test tfgen
.PHONY: development build build_sdks \
examples install_go_sdk install_java_sdk \
install_python_sdk install_sdks only_build \
build_dotnet build_go build_java \
build_nodejs build_python clean \
cleanup help install_dotnet_sdk \
install_nodejs_sdk install_plugins lint_provider \
test tfgen provider

Makefile Outdated Show resolved Hide resolved
provider/pkg/docs-gen/examples/generate.go Outdated Show resolved Hide resolved
provider/pkg/docs-gen/examples/generate.go Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Feb 3, 2023

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

@github-actions
Copy link

github-actions bot commented Feb 3, 2023

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

@github-actions
Copy link

github-actions bot commented Feb 3, 2023

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

@guineveresaenger guineveresaenger merged commit 0e19b79 into master Feb 3, 2023
@guineveresaenger guineveresaenger deleted the docs branch February 3, 2023 21:51
guineveresaenger added a commit to pulumi/ci-mgmt that referenced this pull request Feb 3, 2023
This addition supports Makefile changes introduced to pulumi-docker
in pulumi/pulumi-docker#479.
guineveresaenger added a commit to pulumi/ci-mgmt that referenced this pull request Feb 3, 2023
* Add logic to add a `docs` Makefile target

This addition supports Makefile changes introduced to pulumi-docker
in pulumi/pulumi-docker#479.

* generalize approach to denote a hybrid provider rather than docekr specifically

* Generate all providers. Updates major version for Fastly but does not add any extra targets to non-hybrid providers, as expected.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for Docker Image
2 participants