Skip to content

Docs: Fix link of catalog in terms.md - #12326

Merged
stevenzwu merged 1 commit into
apache:mainfrom
wangyinsheng:fix_doc_link
Feb 19, 2025
Merged

stevenzwu merged 1 commit into
apache:mainfrom
wangyinsheng:fix_doc_link

Conversation

@wangyinsheng

Copy link
Copy Markdown
Contributor

Fix link of catalog in terms.md

@github-actions github-actions Bot added the docs label Feb 19, 2025
@stevenzwu
stevenzwu merged commit 24630c9 into apache:main Feb 19, 2025
Comment thread site/docs/terms.md
The first step when using an Iceberg client is almost always initializing and configuring a catalog. The configured catalog is then used by compute engines to execute catalog operations. Multiple types of compute engines using a shared Iceberg catalog allows them to share a common data layer.

A catalog is almost always configured through the processing engine which passes along a set of properties during initialization. Different processing engines have different ways to configure a catalog. When configuring a catalog, it’s always best to refer to the [Iceberg documentation](../docs/latest/configuration.md#catalog-properties) as well as the docs for the specific processing engine being used. Ultimately, these configurations boil down to a common set of catalog properties that will be passed to configure the Iceberg catalog.
A catalog is almost always configured through the processing engine which passes along a set of properties during initialization. Different processing engines have different ways to configure a catalog. When configuring a catalog, it’s always best to refer to the [Iceberg documentation](docs/latest/configuration.md#catalog-properties) as well as the docs for the specific processing engine being used. Ultimately, these configurations boil down to a common set of catalog properties that will be passed to configure the Iceberg catalog.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might have merged this too soon. the link should be docs/latest/configuration#catalog-properties.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@manuzhang @wangyinsheng do you want to create a new PR?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nm. this syntax also works

@wangyinsheng wangyinsheng Feb 20, 2025 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

might have merged this too soon. the link should be docs/latest/configuration#catalog-properties.

mkdocs will handle the .md suffix in the link.

- When internally linking markdown files to other markdown files, [always use the `.md` suffix](https://github.com/mkdocs/mkdocs/issues/2456#issuecomment-881877986). That will indicate to mkdocs exactly how to treat that link depending on the mode the link is compiled with, e.g. if it becomes a <filename>/index.html or <filename>.html. Using the `.md` extension will work with either mode.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants