What makes really good docs?

I don't know what you consider to be really good docs? I asked on Twitter and here's the answers many of you gave.

After gathering feedback from new inlets users, I decided it was time to give the docs a rethink and a fresh look. Thanks to each one of you that helped me here.

I spent a couple of days making these changes but have been thinking about them for a long time. The move to mkdocs has several advantages including a search feature, dark theme, better URLs and being discoverable on Google.

The code for the new docs is also open source and available on GitHub.

Here's a few screenshots walking you through some of the changes. Ultimately, this site is for you, so let me know at the end what you want to see next - both in the docs and in inlets.

What does it look like now?

The first change you'll see is fewer links, and more use-case driven tutorials.

There's also a new tutorial on how to set up a TCP and HTTPS tunnel on the same server.

The use-cases for inlets have been removed, and compressed down into only the most common 3-4 things we have seen users doing.

The conceptual architecture diagram has been "compressed" into just the bare-essentials to get the message across.

A new FAQ answers many questions from security, to performance to comparisons to other solutions.

You'll also notice that there's a dark theme available if you're working late into the evening.

Wrapping up

Overall I wanted to get a simpler clearer message across for new inlets users and to make it easier for you to find what you need.

Have a great weekend, and feel free to check out the new docs.

Want to get in touch? Feel free to send me an email alex@openfaas.com with comments, questions and suggestions for inlets or the new docs.

You can also contribute or have your blog posts and projects listed. The code is available at https://github.com/inlets/docs.inlets.dev

Alex


Checkout the new inlets docs