Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Topotato docs anatomy topology #131

Open
wants to merge 18 commits into
base: topotato-base
Choose a base branch
from
Prev Previous commit
Next Next commit
fixing getting-started
  • Loading branch information
eznix86 committed Aug 15, 2023
commit c27e57c4f4c9dbf210a83f87cb05125433b3e623
10 changes: 6 additions & 4 deletions docs/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Getting Started
description: Write your first tests
description: Write your first test
---

## Install `topotato`

`topotato` requires Python >= 3.8

Run the following command in your command line:
@@ -29,13 +30,13 @@ apt-get satisfy \

```

## Create your first test {#simpletest}
## Create your first test

1. Create a new file called `test_sample.py`, containing a function, and a
test:
1. Create a new file called `test_sample.py`, containing a function, and a test:

``` python
# content of test_sample.py

#!/usr/bin/env python3
# SPDX-License-Identifier: GPL-2.0-or-later
# Copyright (C) 2018-2022 David Lamparter for NetDEF, Inc.
@@ -123,6 +124,7 @@ class AllStartupTest(TestBase, AutoFixture, topo=topology, configs=Configs):
continue
yield from AssertVtysh.make(r1, daemon, command="show version")
```

2. Run the following command in your command line:

```bash