Skip to content

docs: clean OSS and COS configuration tables#3452

Open
Sidra-009 wants to merge 3 commits into
apache:mainfrom
Sidra-009:cos-docs-clean
Open

docs: clean OSS and COS configuration tables#3452
Sidra-009 wants to merge 3 commits into
apache:mainfrom
Sidra-009:cos-docs-clean

Conversation

@Sidra-009
Copy link
Copy Markdown

summary

fixed formatting issues in OSS and Tencent COS configuration documentation

changes

  • fixed broken markdown table alignment in OSS section
  • cleaned and standardized OSS configuration table
  • separated Tencent COS into its own properly formatted section
  • ensured all configuration keys remain unchanged
  • improved readability of documentation

testing

  • pre-commit checks passed
  • markdown linting passed
  • documentation-only change (no code behavior impact)

@rambleraptor
Copy link
Copy Markdown
Collaborator

This is replacing #3451 right? Do you mind closing out that other PR?

@Sidra-009
Copy link
Copy Markdown
Author

yes, #3452 replaces #3451

i closed the previous PR and kept this one focused only on the OSS/COS documentation changes

Comment thread mkdocs/docs/configuration.md Outdated
Comment on lines +219 to +225
catalog = load_catalog(
**{
"s3.endpoint": "https://cos.ap-guangzhou.myqcloud.com",
"s3.access-key-id": "admin",
"s3.secret-access-key": "password",
}
)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this example truly function without the type or uri properties?

I feel this example doesn't offer much benefit because it's almost a repeat of the table above. We could remove this example.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the feedback i removed the example block

@rambleraptor rambleraptor added this to the PyIceberg 0.12.0 milestone Jun 4, 2026
| s3.secret-access-key | password | Secret key for COS |
| s3.session-token | AQoDYXdzEJr... | Optional session token |

<!-- markdown-link-check-disable -->
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was <!-- markdown-link-check-enable-->. Why did you change it to -disable?


### Alibaba Cloud Object Storage Service (OSS)

<!-- markdown-link-check-disable -->
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you remove this line?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants