cockroachdb / cockroachdb/cockroach
Documentation: getting started guide has outdated examples
Open
Beginner friendly
A-cdc
O-community
T-cdc
X-blathers-triaged
- Dominant language
- Go
- Stars
- 32.5k
- Forks
- 4.1k
- PR merge metrics
- PR metrics pending
Description
The getting started guide references API v1 endpoints that have been deprecated. New users are hitting 404s on their first try.
Specifically:
- The auth example uses the old token format
- The webhook setup section references a removed endpoint
Would be happy to submit a docs PR with updated examples.
Jira issue: CRDB-67720
Contributor guide
Research direction
Start by locating the getting started guide and reviewing the auth example and webhook setup section named in the issue. Compare both examples with the current API behavior, then update the token format and endpoint reference so new users no longer encounter the reported 404s.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100