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

[META] SDK Docsite #43

Open
seanneumann opened this issue Mar 27, 2023 · 0 comments
Open

[META] SDK Docsite #43

seanneumann opened this issue Mar 27, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@seanneumann
Copy link

What/Why

What are you proposing?

As we launch versions of SDK, we should have the corresponding documentation published in lockstep.

What users have asked for this feature?

In general, we've received a lot of feedback on the lack of dev docs for OpenSearch Dashboards. So publishing docs along with SDK changes is critical.

What problems are you trying to solve?

We want developers to use our SDK. Documentation will reduce the barrier to entry and minimize the support we need to provide on educating devs on how to use the SDK.

What is the developer experience going to be?

Unclear. Not sure if it's a dedicated doc site (similar to oui.opensearch.org) or integrated with others.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant