Home

Table of Contents

• Structure
• Naming

Structure

This section provides guidelines about structure for docs. What sections we have and what goes into each one.

Sections

• Introduction
• User Guide
• Tutorials
• Plugins
• Developer Guide
• Testing
• Tools
• Troubleshooting

Introduction

• provides introduction to Ligato and its projects
• should be kept at very high-level

User Guide

• provides information for users; those that use Ligato as-is (vanilla Agent)
• should NOT contain code related to customizing Agent
• might contain code related to clients that use Ligato

Tutorials

• provides various tutorials for developers

Plugins

• provides detail information for all plugins

Developer Guide

• provide information for developers; those that develop with Ligato (custom Agents)
• contains code, examples..

Testing

• provides information for testers

Tools

• provides information for Ligato tools

Troubleshooting

• provides information for troubleshooting something in Ligato

Naming

This provides list of correct naming for anything mentioned in docs.

• Ligato
• ETCD
• Kafka