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

Docs Organization #959

Open
shangyian opened this issue Apr 14, 2024 · 0 comments
Open

Docs Organization #959

shangyian opened this issue Apr 14, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@shangyian
Copy link
Contributor

The docs should cater to the following audiences:

  1. Users who are trying to onboard onto DJ for data modeling. The docs here might want to talk about how to interact with the DJ UI or any of its supported clients.
  2. Users who are trying to set up DJ for internal use at a company. This may include setting up a customized query service, materialization service etc.
  3. Users who are trying to contribute to DJ development and want to run the server locally.

We can group 2 and 3 together into a set of Developer docs, since users who are trying to do 2 will typically need to go through the workflow for 3. The docs for 1 should be in its own section, with the assumption that an instance of DJ is already running and ready for the user to use.

@shangyian shangyian added the documentation Improvements or additions to documentation label Apr 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant