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

Proposal: Separate server & admin docs from user-facing docs #1351

Open
1 task done
databyjp opened this issue Nov 23, 2023 · 0 comments
Open
1 task done

Proposal: Separate server & admin docs from user-facing docs #1351

databyjp opened this issue Nov 23, 2023 · 0 comments
Labels
backlog No current plans to work on this discussion/suggestion documentation Improvements or additions to documentation enhancement New feature or request

Comments

@databyjp
Copy link
Contributor

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:

  • Server documentation for administrators
  • Usage documentation for developers/data scientists

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

@databyjp databyjp added documentation Improvements or additions to documentation enhancement New feature or request backlog No current plans to work on this discussion/suggestion labels Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog No current plans to work on this discussion/suggestion documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant