A completely updated WAF documentation portal is now available at docs.wallarm.com. Switching to the new docs platform allowed us to expand the capabilities of the portal. This has made navigation across the portal more convenient. In addition, it has greatly simplified the updates of the documents.

Notable changes

• We added a "live" search widget. Moreover, search results now include a context. For example, if you search the word Docker, then you'll not only get a list of the relevant articles but also a brief context of where this keyword is used.
• For each article, a document outline is now visible on the right side of the page. This is especially useful for navigating through longer technical documents.
• Our favorite change yet allows everyone to have the opportunity to contribute and make our docs better! We are allowing everyone to edit content via pull requests in GitHub repo with the documentation content. To start editing, click the edit icon on the page you want to change, push changes to the forked repo, and create a pull request to our repo! It’s that easy.

Technical details

We know many of our customers support the documentation for their products themselves. Therefore, we want to share some technical details about the chosen platform.

Previously, we built docs with GitBook, which was outstanding. Unfortunately, open GitBook is no longer supported. While choosing a new platform, we tried a variety of options, such as Docusaurus, Vuepress, or Gatsby, and ended up choosing the remarkable MkDocs / MkDocs Material. But the details of analyzing and moving to a new platform deserve a separate post in our blog.

We are looking forward to hearing your feedback! Please email support@wallarm.com with any comments, concerns, or questions.