Skip to content

Commit 76ea7b9

Browse files
Troubleshooting/logging enhancements (#16793)
* Enhance support documentation by adding "Troubleshooting" section and guide for filing GitHub issues * Implement documentation review suggestions - Add (GCP) clarification for Google Cloud provider - Change "Check our guide" to "See our guide" for consistency - Add Community Slack mention earlier in filing-issues guide - Add troubleshooting guide link in "Before you file" section Co-authored-by: Cam Soper <CamSoper@users.noreply.github.com> --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Cam Soper <CamSoper@users.noreply.github.com>
1 parent 3edc95c commit 76ea7b9

File tree

3 files changed

+129
-7
lines changed

3 files changed

+129
-7
lines changed

content/docs/support/_index.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Support
3-
linktitle: Support
2+
title: Support & Troubleshooting
3+
linktitle: Support & Troubleshooting
44
docs_home: true
55
notitle: true
66
norightnav: true
@@ -10,15 +10,20 @@ menu:
1010
weight: 1
1111
meta_desc: Get help with Pulumi through FAQs, troubleshooting guides, community resources, and support options.
1212
meta_image: /images/docs/meta-images/docs-meta.png
13-
h1: Support
14-
description: <p>Get help with Pulumi through troubleshooting guides, debugging tools, FAQs, and community resources.</p>
13+
h1: Support & Troubleshooting
14+
description: <p>Get help with Pulumi through logging, troubleshooting guides, debugging tools, FAQs, and community resources.</p>
1515
aliases:
1616
- /docs/support/
1717

1818
sections:
1919
- type: button-cards
2020
heading: Getting started
2121
cards:
22+
- emoji: 📊
23+
heading: Logging
24+
link: /docs/support/debugging/logging/
25+
description: CLI verbose logging and program logging for debugging and diagnostics.
26+
2227
- emoji: 🔧
2328
heading: Troubleshooting
2429
link: /docs/support/troubleshooting/
@@ -41,8 +46,8 @@ sections:
4146

4247
- emoji: 🐙
4348
heading: GitHub Issues
44-
link: https://github.com/pulumi/pulumi/issues
45-
description: Report bugs and request features.
49+
link: /docs/support/filing-issues/
50+
description: Learn how to report bugs and request features in the right repository.
4651

4752
- emoji: 📧
4853
heading: Contact Support
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
title: Filing GitHub Issues
3+
title_tag: "Filing GitHub Issues with Pulumi"
4+
meta_desc: Learn how to file bugs and feature requests in the correct Pulumi repository for faster resolution.
5+
h1: Filing GitHub Issues
6+
meta_image: /images/docs/meta-images/docs-meta.png
7+
menu:
8+
support:
9+
name: Filing Issues
10+
parent: support-home
11+
weight: 5
12+
identifier: support-filing-issues
13+
---
14+
15+
When you encounter a bug or have a feature request, filing it in the correct GitHub repository helps our team respond faster and more effectively. Use this guide to determine where to file your issue.
16+
17+
{{% notes type="info" %}}
18+
Need help troubleshooting first? Join the [Pulumi Community Slack](https://slack.pulumi.com/) to get quick answers from the community, or check our [troubleshooting guide](/docs/support/troubleshooting/).
19+
{{% /notes %}}
20+
21+
## Quick decision guide
22+
23+
Follow this decision tree to find the right repository:
24+
25+
1. **Is this about documentation?**[pulumi/docs](https://github.com/pulumi/docs/issues)
26+
1. **Is this about a Registry example?** → The corresponding provider repository (see below)
27+
1. **Is this about a cloud provider or resource?** → The corresponding provider repository (see below)
28+
1. **Everything else**[pulumi/pulumi](https://github.com/pulumi/pulumi/issues)
29+
30+
## Documentation issues
31+
32+
If you've found an error, typo, or missing information in the Pulumi documentation website, please file an issue in the [pulumi/docs repository](https://github.com/pulumi/docs/issues).
33+
34+
**Examples:**
35+
36+
- Broken links in documentation
37+
- Outdated code samples in guides
38+
- Missing or unclear explanations
39+
- Typos or grammatical errors
40+
41+
## Registry example issues
42+
43+
This is a common source of confusion: Registry examples are maintained in provider repositories, not the main Pulumi repository.
44+
45+
If you find a bug in a Registry example (like example code that doesn't work or is outdated), file the issue in the **provider repository** for that cloud provider or service.
46+
47+
**Examples:**
48+
49+
- Bug in an AWS Registry example → [pulumi/pulumi-aws](https://github.com/pulumi/pulumi-aws/issues)
50+
- Bug in an Azure Registry example → [pulumi/pulumi-azure-native](https://github.com/pulumi/pulumi-azure-native/issues)
51+
- Bug in a Kubernetes Registry example → [pulumi/pulumi-kubernetes](https://github.com/pulumi/pulumi-kubernetes/issues)
52+
53+
{{% notes type="tip" %}}
54+
On any Registry page, you can find a link to the provider's repository in the "Repository" section.
55+
{{% /notes %}}
56+
57+
## Provider and resource issues
58+
59+
If you're experiencing issues with a specific cloud provider or resource (errors, missing features, unexpected behavior), file the issue in that provider's repository.
60+
61+
### Major provider repositories
62+
63+
- **AWS**[pulumi/pulumi-aws](https://github.com/pulumi/pulumi-aws/issues) or [pulumi/pulumi-aws-native](https://github.com/pulumi/pulumi-aws-native/issues)
64+
- **Azure**[pulumi/pulumi-azure-native](https://github.com/pulumi/pulumi-azure-native/issues) or [pulumi/pulumi-azure](https://github.com/pulumi/pulumi-azure/issues)
65+
- **Google Cloud (GCP)**[pulumi/pulumi-gcp](https://github.com/pulumi/pulumi-gcp/issues) or [pulumi/pulumi-google-native](https://github.com/pulumi/pulumi-google-native/issues)
66+
- **Kubernetes**[pulumi/pulumi-kubernetes](https://github.com/pulumi/pulumi-kubernetes/issues)
67+
68+
### Finding other provider repositories
69+
70+
For other providers, visit the [Pulumi Registry](https://www.pulumi.com/registry/), search for your provider, and click through to its repository.
71+
72+
## Core Pulumi issues
73+
74+
File issues in the main [pulumi/pulumi repository](https://github.com/pulumi/pulumi/issues) for:
75+
76+
- Pulumi CLI bugs or feature requests
77+
- Pulumi engine issues
78+
- State management problems (not specific to a provider)
79+
- Language SDK issues (TypeScript, Python, Go, .NET, Java)
80+
- Issues with `pulumi new`, `pulumi up`, `pulumi preview`, etc.
81+
- Pulumi Cloud-related issues (though you can also [contact support](/contact/))
82+
83+
**Examples:**
84+
85+
- The `pulumi up` command crashes
86+
- State file becomes corrupted
87+
- Problems with stack references
88+
- Issues with secrets encryption
89+
- Language-specific SDK bugs
90+
91+
## Still not sure?
92+
93+
If you're unsure where to file your issue:
94+
95+
1. Start with [pulumi/pulumi](https://github.com/pulumi/pulumi/issues) - the team can redirect you if needed
96+
1. Join the [Pulumi Community Slack](https://slack.pulumi.com/) and ask in the #general channel
97+
1. [Contact support](/contact/) if you're on a paid plan
98+
99+
## Before you file
100+
101+
To help us resolve your issue quickly:
102+
103+
1. **Check the troubleshooting guide** - see our [troubleshooting documentation](/docs/support/troubleshooting/) for solutions to common issues
104+
1. **Search existing issues** - your issue might already be reported
105+
1. **Include version information** - run `pulumi version` and include the output
106+
1. **Provide reproduction steps** - minimal code examples are extremely helpful
107+
1. **Enable verbose logging** - see our [logging guide](/docs/support/debugging/logging/) for instructions
108+
1. **Redact sensitive information** - remove credentials, tokens, and secrets from logs
109+
110+
{{% notes type="warning" %}}
111+
Be careful when sharing logs - they may contain sensitive information like credentials or tokens. Always review and redact logs before posting them publicly.
112+
{{% /notes %}}

content/docs/support/troubleshooting/_index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ sections:
2525
- type: button-cards
2626
heading: Getting started
2727
cards:
28+
- emoji: 📊
29+
heading: Logging
30+
link: /docs/support/debugging/logging/
31+
description: CLI verbose logging and program logging for debugging and diagnostics.
32+
2833
- emoji: ⚠️
2934
heading: Common Issues
3035
link: /docs/support/troubleshooting/common-issues/
@@ -44,7 +49,7 @@ sections:
4449
heading: Need more help?
4550
description_md: |
4651
- Join [Community Slack](https://slack.pulumi.com) for fast community support
47-
- Open [GitHub Issues](https://github.com/pulumi/pulumi/issues/new) to report bugs
52+
- See our [guide for filing GitHub issues](/docs/support/filing-issues/) to report bugs in the right repository
4853
- [Contact us](/contact/) for paid support options
4954
5055
- type: flat

0 commit comments

Comments
 (0)