influxdata / influxdata/docs-v2
Add API reference for InfluxDB 3 Cloud
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
Cloud pages don't exist yet at the paths below, so content/influxdb3/cloud/request-information.md aliases them to a "Request more information" page. Publish the real content and remove the alias.
Closest existing equivalent to source from: api-docs/influxdb3/enterprise/
Aliased paths
-
/influxdb3/cloud/api/database/ -
/influxdb3/cloud/api/query-data/ -
/influxdb3/cloud/api/table/ -
/influxdb3/cloud/api/v3/
Anchors the new content must provide
Shared content deep-links to these fragments. They're currently faked as hidden <span>s in request-information.md; remove each span once the real heading exists.
#operation/DeleteConfigureDatabase#operation/DeleteConfigureTable#operation/GetConfigureDatabase#operation/GetExecuteQuerySQL#operation/GetV1ExecuteQuery#operation/PostConfigureDatabase#operation/PostConfigureTable#tag/Database#tag/Table
Done when
- Content is published (or the linking shared content is gated for Cloud)
- The alias is removed from
request-information.md - Any hidden anchor
<span>s that belonged to these paths are removed -
link-checkerpasses
Part of #7391.
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.
Research direction
Compare the existing API reference in api-docs/influxdb3/enterprise/ with the four aliased Cloud paths, starting from content/influxdb3/cloud/request-information.md. Publish the corresponding Cloud content, remove the alias and hidden anchor spans, and run link-checker to confirm the listed paths and fragments work.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100