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 automated install instructions to top of installation-configuration.md. #2207

Merged
merged 2 commits into from
Jul 19, 2024

Conversation

guineveresaenger
Copy link
Contributor

This PR adds an "Installation" section to the configuration docs, generating content dynamically from the package info.

Fixes #2206.

…age name.

Refactor functionality into new file. Add unit tests.
@guineveresaenger guineveresaenger requested review from iwahbe and a team July 19, 2024 17:49
Copy link

codecov bot commented Jul 19, 2024

Codecov Report

Attention: Patch coverage is 53.96825% with 29 lines in your changes missing coverage. Please review.

Project coverage is 60.60%. Comparing base (11e23df) to head (453fc8b).
Report is 2 commits behind head on master.

Files Patch % Lines
pkg/tfgen/installation_docs.go 53.96% 29 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2207      +/-   ##
==========================================
- Coverage   61.30%   60.60%   -0.71%     
==========================================
  Files         353      355       +2     
  Lines       38512    46324    +7812     
==========================================
+ Hits        23611    28076    +4465     
- Misses      13354    16694    +3340     
- Partials     1547     1554       +7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

LGTM

Comment on lines +24 to +29
//TODO: See https://github.com/pulumi/pulumi-terraform-bridge/issues/2078
// - translate code blocks with code choosers
// - apply default edit rules
// - reformat TF names
// - Translation for certain headers such as "Arguments Reference" or "Configuration block"
// - Ability to omit irrelevant sections
Copy link
Member

Choose a reason for hiding this comment

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

I think this accurately describes the set of features we need to start shipping this on tier 2 providers.

Comment on lines +35 to +37
"title: %[1]s Installation & Configuration\n"+
"meta_desc: Provides an overview on how to configure the Pulumi %[1]s.\n"+
"layout: package\n"+
Copy link
Member

Choose a reason for hiding this comment

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

These are excellent places to use backtick based strings.

@guineveresaenger guineveresaenger merged commit 99938e1 into master Jul 19, 2024
11 checks passed
@guineveresaenger guineveresaenger deleted the guin/install-instructions-generate branch July 19, 2024 21:07
@mjeffryes mjeffryes added this to the 0.107 milestone Jul 24, 2024
@pulumi-bot
Copy link
Contributor

This PR has been shipped in release v3.88.0.

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.

Generate installation section for a bridged provider
4 participants