pingcap / pingcap/docs-tidb-operator
Prerequisites in access-dashboard.md seems out of date
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 52
- Forks
- 129
- Avg merge
- 12m
- Merged PRs (30d)
- 2
Description
Question
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Before submitting your question, make sure you have:
- Searched existing Stack Overflow questions.
- Googled your question.
- Read the documentation:
Now, please describe your question here:
Prerequisites in access-dashboard.md set spec.pd.enableDashboardInternalProxy: true, which is marked as Deprecated in code, do we need change doc to set spec.pd.config.dashboard.internal-proxy in place?
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
Read the Prerequisites section in access-dashboard.md and compare its setting with the deprecated declaration in pkg/apis/pingcap/v1alpha1/types.go around lines 552-555. Confirm the supported configuration and update the documentation if needed, then verify that the example no longer recommends the deprecated field.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100