Skip to content

Commit 4ddc5cb

Browse files
committed
minor docs fixes
Signed-off-by: Bruno Bernard <[email protected]>
1 parent 0e719aa commit 4ddc5cb

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

docs/anatomy/assets/anatomy.svg

Lines changed: 17 additions & 0 deletions
Loading

docs/anatomy/overview.mdx

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Tests in the topotato framework are structured into different sections that collectively define the test's behavior, topology, and configurations. This document provides an overview of these sections and their components.
44

5+
<Image src="/anatomy/assets/anatomy.svg" caption="Topotato structure" />
6+
7+
58

69
### Header
710

@@ -37,6 +40,8 @@ __topotests_rev__ = 'a770da1b1c6290f53cc69218a30360accd6a0068'
3740

3841
These markers provide information about the topotato version, the test file, and the revision, aiding in managing compatibility and version control.
3942

43+
</hr>
44+
4045
### Topology Definition
4146

4247
In topotato, a test topology is defined using ASCII diagrams enclosed within a function marked with the `topology_fixture` decorator. Here's an example of defining a topology named `topo1`:
@@ -54,11 +59,13 @@ The ASCII diagram visually represents the topology. The function's name `topo1`
5459

5560
<Info>But if complexity grows, it might be better to split the tests into separate files.</Info>
5661

62+
</hr>
63+
5764
### FRR Configurations
5865

59-
Topotato generates FRR configurations using [jinja2](https://palletsprojects.com/p/jinja/) templates embedded within the test script. Configuration templates define various aspects of router behavior. Here's an example of defining FRR configurations:
66+
Topotato generates FRR configurations using [Jinja2](https://palletsprojects.com/p/jinja/) templates embedded within the test script. Configuration templates define various aspects of router behavior. Here's an example of defining FRR configurations:
6067

61-
<Warning>Jinja2 template used has been customized a little bit.</Warning>
68+
<Warning>This Jinja2 template used has been customzied. See [`frr configuration section`](/anatomy/frr-config)</Warning>
6269

6370
```python
6471
class Configs(FRRConfigs):
@@ -83,6 +90,8 @@ These configurations can reference dynamic variables, making them more maintaina
8390

8491
Each *daemon* can be configured for each routers by using their respective name and configuration.
8592

93+
</hr>
94+
8695
### Test Classes
8796

8897
All topotato tests are organized within classes that inherit from the `TestBase` class. The class definition binds together the test content, topology, and configurations. Here's an example:

0 commit comments

Comments
 (0)