Proposal: Separate server & admin docs from user-facing docs #1351
Labels
backlog
No current plans to work on this
discussion/suggestion
documentation
Improvements or additions to documentation
enhancement
New feature or request
Code of Conduct
What part of document/web-page on weaviate.io is affected?
The documentation is growing larger as Weaviate grows.
With the growth we are seeing differentiation in capabilites as well as roles. To better serve different users and make it easier to find information, I propose to separate the docs into:
This will mean that for example, the replication configuration page will be on the server side, whereas the how-to search pages would be on the user side.
Some pages like text2vec-openai will be split. There will be a section for enabling the module & providing environment variables for example, and another for users.
The user section for text2vec-openai might become two pages, one for OpenAI and another for Azure OpenAI.
As our users' roles become more specialised & separated, this will help make the documentation easier to use.
Additional comments?
No response
The text was updated successfully, but these errors were encountered: