docs: register s3 module in docs index config - #174
Merged
Merged
Conversation
The s3 module was in the manifest but missing from module_index_config.yaml, so make docs-index warned and silently excluded it from both docs sites.
Contributor
There was a problem hiding this comment.
Trivially correct — s3 was in the manifest but missing from the docs index config, so make docs-index warned and dropped it. This adds it to the right category with matching metadata.
What I checked
| Area | Status |
|---|---|
modules: [cache, persistdict, s3] placement under storage |
✅ Correct category |
Metadata fields (benchmark, replaces, desc_en/zh) |
✅ Consistent with other entries; boto3, minio, s3fs matches bench-s3 extra in pyproject.toml |
| YAML syntax / indentation | ✅ Clean |
Insertion point (before depdetect) |
✅ Alphabetical within category block |
| CI | ⏳ Pending (YAML-only change, no code impact) |
PR body correctly notes s3.md doesn't exist yet (same situation as profiler) — worth a follow-up to write both.
LGTM 👍
Contributor
There was a problem hiding this comment.
Docs-only, single-file YAML change — straightforward.
Checked:
s3added to thestoragecategory module list ✅- Module metadata (descriptions, replaces, benchmark) filled in, both EN and ZH ✅
benchmark: boto3matches thebench-s3extra in pyproject.toml ✅- Placement in the modules map is consistent with the category grouping ✅
CI still pending but this is a config YAML change that won't affect lint or tests.
LGTM 👍
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
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.
Summary
The
s3module has been inmanifest.jsonbut was never added to_scripts/module_index_config.yaml. As a resultmake docs-indexemitted:and s3 was silently missing from both the EN and ZH docs sites.
This adds s3 to the
storagecategory and fills in its metadata(description, replaces list, benchmark target). The
boto3, minioreferencelibraries match the existing
bench-s3extra inpyproject.toml.Notes
docs/modules/index.mdfor both languages is alreadypushed to the
docs_en/docs_zhworktree branches.s3.mddoesn't exist as a doc page yet, so the index link is currentlydead — same situation as
profiler, which is also indexed without a page.Worth a follow-up to write both.
Test plan
make docs-indexruns clean with no warning