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 out of date #38

Closed
ghost opened this issue Apr 30, 2018 · 4 comments
Closed

Docs out of date #38

ghost opened this issue Apr 30, 2018 · 4 comments

Comments

@ghost
Copy link

ghost commented Apr 30, 2018

Docs need updating for 0.4.0 specifically:

  • timeseries blob client needs documenting

  • requirements of value field in time series write needs documenting

  • need to document that time series write json supports at most 1 tag field with a string

  • need to document where to get reqEndpoint from (both as a driver and for datasources in apps)

  • need to document that process.env["DATASOURCE_XXX"] returns the meta data for that datasource required to connect to the store and make a client

@haddadi
Copy link
Contributor

haddadi commented Apr 30, 2018

and perhaps a hint to where to get the password from for the dashboard in case someone is not terminal friendly.

@jptmoore
Copy link

I currently keep the documentation updated here: https://jptmoore.github.io/zestdb/

This tends to have features ahead of the current Databox release but the Databox client libraries should document the release features which are linked from core-store here: https://github.com/me-box/core-store

@Toshbrown
Copy link
Contributor

Had a go at updating the docs here https://github.com/me-box/lib-node-databox/tree/update-docs feedback welcome.

@Toshbrown
Copy link
Contributor

Updated in #40

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

3 participants