crate-admin icon indicating copy to clipboard operation
crate-admin copied to clipboard

Adding documentation to admin ui

Open bputt opened this issue 7 years ago • 3 comments

Use case: Embedding documentation into the admin ui

Feature description: It'd be beneficial to have Crate's documentation included in the admin ui for companies that have a self-hosted instance that may be on a intranet.

Referring to the documentation that lives here: https://crate.io/docs/reference/

bputt avatar Mar 08 '17 20:03 bputt

hi @bputt, thanks for your suggestion. just to understand the reason better? do you have problems accessing the CrateDB documentation? is our page locked? is it to slow? we try to keep it up to date and not have outdated documentation spread with every CrateDB installation. cheers, johannes

joemoe avatar Mar 13 '17 12:03 joemoe

Your documentation loads fine, it's more of a "nice-to-have" for offline installs. Although, I'm guessing one could build your https://github.com/crate/crate-web and use that as well.

Plus, you're providing documentation on a specific version of crate, so they shouldn't get outdated, unless you update documentation for older versions.

bputt avatar Mar 13 '17 18:03 bputt

@bputt i will add this to our backlog.

joemoe avatar Mar 14 '17 07:03 joemoe