Skip to content

Files

Failed to load latest commit information.

Latest commit

 Cannot retrieve latest commit at this time.

History

History

2018-10-31_writeTheDocsTLV_docs-as-code-at-logzio

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

readme.md

Tools we use at Logz.io

The last slide shows the tools I chose for Logz.io docs. I'm also putting them here for easier reference.

The docs

Web address: docs.logz.io Repo: github.com/logzio/logz-docs

Tools

  • Hosting, continuous delivery: Netlify

  • Static site generator: Jekyll, with a custom template

  • Access management: GitHub

  • API: ReDoc

  • Search: Lunr.js

  • Text editing: Visual Studio Code (I highly recommend it).

    • You can see my configuration, so maybe you'll find some useful extensions, linters, etc.
    • Whatever static site generator you use, see if it has an extension for Visual Studio Code. It's an unbelievable time saver.

Reach me

You can find me on LinkedIn or here on GitHub (https://github.com/imnotashrimp).

You can also find me in the Write the Docs Slack community (username imnotashrimp). Join here.