[DOC] Point the contributing documents section to apache/iotdb-docs - #18542
Open
godarrenw wants to merge 1 commit into
Open
[DOC] Point the contributing documents section to apache/iotdb-docs#18542godarrenw wants to merge 1 commit into
godarrenw wants to merge 1 commit into
Conversation
Signed-off-by: Zhu yizhang <95731595+godarrenw@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The "Contributing documents" section of
CONTRIBUTING.mddescribes adocs/directory that no longer exists in this repository, so a new contributor who wants to fix a documentation page has nowhere to go.git ls-tree -r --name-only HEAD | grep '^docs/'returns nothing — the website content now lives in apache/iotdb-docs (last pushed 2026-08-24), under itssrcdirectory.Almost every line of that section is now inaccurate, so this PR updates it:
Location.
docs/...→apache/iotdb-docs,src/....Directory list. I checked each path against
apache/iotdb-docsrather than assuming the layout carried over:docs/UserGuidesrc/UserGuidedocs/zh/UserGuidesrc/zh/UserGuidedocs/Communitysrc/Communitydocs/zh/Communitysrc/zh/Communitydocs/Developmentsrc/Developmentdocs/zh/Developmentdocs/SystemDesigndocs/zh/SystemDesignThe three that no longer exist are dropped from the list.
Version mapping. The section said versions map to branches (
In progress -> master,major_version.x -> rel/major_version).apache/iotdb-docshas norel/*branches — its only non-dependabot branches aremainandTableAuth— and versions are directories instead:src/UserGuide/containsMaster,latest,latest-Table,V1.3.x,V1.2.x,V0.13.x,dev-1.3. The text now says that.The "Precautions" bullets below (image hosting in
iotdb-bin-resources, Unicode and dollar-sign rules) still apply and are untouched.How I checked
Every path in the new list was resolved through the GitHub contents API against
apache/iotdb-docs, and the branch list was read from the branches API. The absence ofdocs/here was confirmed withgit ls-treeon the currentmaster(6aec4b8) rather than by looking at a working copy.I searched the issue tracker and open PRs first and did not find an existing report or anyone working on this, so there is no issue to reference. If one exists that I missed, I'm happy to link it.
Disclosure: prepared with AI assistance; every path and branch above was verified against the live repositories.