Documentation revamp: making Hue easier to install, use and develop

Documentation revamp: making Hue easier to install, use and develop

Making Hue easier to install, use and develop with a modern documentation.

While all the efforts on the improving the core SQL Experience are important, not communicating clearly about it is not very efficient. In consequence, the documentation website was rewritten and its content is now being continuously refreshed.

Before

Can be seen in older version: http://cloudera.github.io/hue/docs-4.3.0/

After

Can be seen in latest: http://cloudera.github.io/hue/latest/

 

 

Table of content

It was unified in the left navigation, and we now see the four sections within the same page:

Left side Main Table of Content

Sub sections of the page are now directly fixed on the right with quick links.

Right side Table of Content

This list the next level of headers within the currently open page. Those are perfect quick links and for getting an overview of the page content.

Breadcrumbs

The top header of the page is fixed and display the navigation tree used.

Styling

Easy to see and copy/paste instructions with one clip to put into the clipboard.

Search

On the top left, it searches across all the table of content and within each page.

Feedback

Reporting issues or sending a suggestion is one click away via GitHub, so feel free to send some pull requests!

 

Thank you to everybody using the product and who contributed. One popular ask is to make it simpler to use the SQL Connectors and this will be improved next.

As usual feel free to comment here or to send feedback to the hue-user list or @gethue!