Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moving documentation to https://duckdb.org/community_extensions/ #161

Open
carlopi opened this issue Oct 22, 2024 · 2 comments
Open

Moving documentation to https://duckdb.org/community_extensions/ #161

carlopi opened this issue Oct 22, 2024 · 2 comments

Comments

@carlopi
Copy link
Collaborator

carlopi commented Oct 22, 2024

We are in the process of move hosting of the documentation from https://community-extensions.duckdb.org/
to https://duckdb.org/community_extensions/

There are various reasons for that, mainly to simplify process on our side and use @szarnyasg competence to the fullest.
We already have a process for updating / iterating the main website, and moving there would allow to centralize a lot of the work.

Extension endpoint will still be (it's baked in duckdb) at:
http(s)://community-extensions.duckdb.org/VERSION/PLATFORM/NAME.duckdb_extension[.wasm]
And redirects will be set-up from old to new location.

This would allow shorter iterations in contributing to the docs, and shorter latency in having docs updated.

Extension pages (those at community_extensions/extensions/NAME, for example: https://duckdb.org/community_extensions/extensions/lindel) will still be autogenerated using as source of truth the descriptors AND doing difference between function/settings/etc lists before and after extension is loaded.
This means that to modify a given extension description, example or such a PR would need to be made at duckdb/community-extensions, and this barred minor nit has to be greenlighted by one of the extension maintainers.

General pages (top level at https://duckdb.org/community_extensions) like for example https://duckdb.org/community_extensions/development or such will be generated starting from the markdown files at https://github.com/duckdb/duckdb-web/tree/main/community_extensions, and to improve those a PR has to be made at duckdb/duckdb-web.

It's not properly done, but opening this to inform you of what's happening. This might generate some confusion but it's better done now that later down the road.

If you have feedbacks or improvements you would like to see, feel free to comment here or on the community-extension's channel at https://discord.duckdb.org.

Thanks all!

@nicosuave
Copy link

An extremely minor usability tweak, but adding a List Extensions or similar to the top navbar would make things more intuitive

@carlopi
Copy link
Collaborator Author

carlopi commented Oct 23, 2024

An extremely minor usability tweak, but adding a List Extensions or similar to the top navbar would make things more intuitive

done! See https://duckdb.org/community_extensions/, thanks for the feedback

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

No branches or pull requests

2 participants