influxdata / influxdata/docs-v2
Add Troubleshooting section with additional context on API errors
@jstirnaman is already working on this.
Since Jul 22, 2024.
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
While we have documentation available for the APIs exposed by Dedicated,
- the API contents are not exposed well in the docs search
- details of error responses and behavior does not have much context in the API docs
For a concrete example, we should provide advice on how clients should handle 429 and 503 responses.
Similar to the docs for our other products, the Cloud Dedicated docs should have a "Troubleshooting" section with a "FAQs" and/or "error messages" page with additional context on API (and other errors) which can be encountered. This could be similar to the [Enterprise FAQs page](https://docs.influxdata.com/enterprise_influxdb/v1/troubleshooting/frequently-asked-questions/).
##### Relevant URLs
- https://docs.influxdata.com/influxdb/cloud-dedicated/reference/api/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.