Skip to content

Commit

Permalink
add Getting Help page to docs community section
Browse files Browse the repository at this point in the history
  • Loading branch information
sryza committed Oct 11, 2023
1 parent 9eaabab commit 2687518
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions docs/content/community/getting-help.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Getting Help | Dagster
description: Have questions about how to use Dagster? Hit a bug? Have a feature request? This page includes tips on what to do.
---

# Guide to Getting Help

Have questions about how to use Dagster? Hit a bug? Have a feature request? The Dagster Labs team and the Dagster community make a best-effort attempt to respond, on a few different platforms.

For Dagster Cloud users, an Enterprise contract also comes with a guaranteed SLA.

### Searching for answers

Search engines like Google generally do a good job at surfacing relevant Dagster docs, Github Discussions and Github Issues, so we recommend starting there.

Unfortunately, ChatGPT is not currently a great resource for answering questions about Dagster, because the corpus it was trained on doesn’t include Dagster’s latest APIs.

### Bugs and feature requests go in Github Issues

We use [Github Issues](https://github.com/dagster-io/dagster/issues) to track all bugs and feature requests from the community.

If you have a request of the form, “I want Dagster to do X, but it seems like it doesn’t”, consider filing a Github Issue instead of posting a Slack message. In most cases, our response on Slack will be to ask you to file a Github Issue, which makes it easier to track your request.

If you find a Github issue that seems like it’s related to the issue you’re experiencing, but you're not sure, don’t be shy about posting on that Github issue to ask. We can redirect it to a different issue if necessary.

Pro-tip: if your Github issue includes a code snippet, add syntax highlighting by specifying the language at the top of the block:

```
```python
from dagster import ...
...
```

### Github Discussions: the preferred place to ask questions

[Github Discussions](https://github.com/dagster-io/dagster/discussions) is the main Q & A site for Dagster. For questions whose answers might be useful to others (which is most questions), Github Discussions is the best place to ask them, because they show up when others Google the same questions.

Pro-tip: if your Github issue includes a code snippet, add syntax highlighting by specifying the language at the top of the block:

```
```python
from dagster import ...
...
```

### The #dagster-support Slack channel: another place to ask questions

The Dagster community also answers questions in the #dagster-support channel of the [Dagster Slack](https://dagster.io/slack). We strongly encourage you to join Slack, as it's the main real-time gathering place for the community. But we are slowly moving Q & A from Slack to Github Discussions and are more responsive on the latter.

### Short questions > long questions

The less time and effort it takes for someone to digest your question, the more likely it will get answered. If you're hitting an issue, try to trim code snippets to the smallest size needed to reproduce it.

There's a balancing act here, because it's often useful for us to understand the larger context that your question is from. One strategy is to separate your question into two sections:
- A tightly-scoped section that describes the precise behavior you're expecting from Dagster
- A section with the background on the larger task you're trying to accomplish, why you care about this behavior, context on your data platform, etc.

0 comments on commit 2687518

Please sign in to comment.