diff --git a/docs/tutorials/common/grpc.md b/docs/tutorials/common/grpc.md index 71630d38..2a85d7c8 100644 --- a/docs/tutorials/common/grpc.md +++ b/docs/tutorials/common/grpc.md @@ -18,5 +18,5 @@ the remaining steps of a given section. ``` 4. You will be presented with sessions to join, select the one created by the script

- +

diff --git a/docs/tutorials/tutorial1.md b/docs/tutorials/tutorial1.md index 75f13c7c..7bda7e7f 100644 --- a/docs/tutorials/tutorial1.md +++ b/docs/tutorials/tutorial1.md @@ -6,7 +6,7 @@ This tutorial will cover some use cases when using a wired 2 node scenario in CORE.

- +

## Files @@ -46,11 +46,11 @@ between nodes in CORE. ``` * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**

- +

* You can now click on the **Start Session** button to run the scenario

- +

* Open a terminal on **n1** by double clicking it in the GUI * Run the following in **n1** terminal @@ -84,11 +84,11 @@ traffic being sent/received among many other uses. ``` * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**

- +

* You can now click on the **Start Session** button to run the scenario

- +

* Open a terminal on **n1** by double clicking it in the GUI * Open a terminal on **n2** by double clicking it in the GUI @@ -123,20 +123,20 @@ beneficial for understanding how software will behave in adverse conditions. ``` * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**

- +

* You can now click on the **Start Session** button to run the scenario

- +

* Right click the link between **n1** and **n2** * Select **Configure**

- +

* Update the loss to **25**

- +

* Open a terminal on **n1** by double clicking it in the GUI * Run the following in **n1** terminal @@ -166,11 +166,11 @@ within the nodes of our scenario. ``` * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**

- +

* You can now click on the **Start Session** button to run the scenario

- +

* Open a terminal on **n1** by double clicking it in the GUI * Run the following in **n1** terminal @@ -216,11 +216,11 @@ using `tail -f` to observe the output of running software. ``` * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario_service.xml**

- +

* You can now click on the **Start Session** button to run the scenario

- +

* Open a terminal on **n1** by double clicking it in the GUI * Run the following in **n1** terminal diff --git a/docs/tutorials/tutorial2.md b/docs/tutorials/tutorial2.md index 5455917b..7b82e04e 100644 --- a/docs/tutorials/tutorial2.md +++ b/docs/tutorials/tutorial2.md @@ -30,7 +30,7 @@ XML scenario file, leveraging an NS2 mobility file. * Navigate to and select this tutorials **scenario.xml** file * You can now click play to start the session

- +

* Note that OSPF routing protocol is included in the scenario to provide routes to other nodes, as they are discovered * Double click node **n4** to open a terminal and ping node **n2** @@ -49,7 +49,7 @@ XML scenario file, leveraging an NS2 mobility file. * Right click on the **wlan1** node and select **WLAN Config**, then set delay to 500000

- +

* Using the open terminal for node **n4**, ping **n2** again, expect about 2 seconds delay ```shell @@ -69,7 +69,7 @@ XML scenario file, leveraging an NS2 mobility file. * Right click on the **wlan1** node and select **WLAN Config**, set delay back to 5000 and loss to 10

- +

* Using the open terminal for node **n4**, ping **n2** again, expect to notice considerable loss ```shell @@ -111,7 +111,7 @@ gRPC python script and providing mobility over the gRPC interface. * You will now have joined the already running scenario

- +

## Running Software diff --git a/docs/tutorials/tutorial3.md b/docs/tutorials/tutorial3.md index 362803fc..eaa2a5e6 100644 --- a/docs/tutorials/tutorial3.md +++ b/docs/tutorials/tutorial3.md @@ -71,7 +71,7 @@ file, leveraging an NS2 file for mobility. known and when the routes are discovered, ping will work

- +

## Running with the gRPC Script @@ -94,11 +94,11 @@ This section covers using a gRPC script to create and provide scenario movement. * You will now have joined the already running scenario * In the terminal running the **scenario.py**, hit a key to start motion

- +

* Observe the link between **n3** and **n4** is shown and then as motion continues the link breaks

- +

## Running the Chat App Software @@ -151,5 +151,5 @@ API. * Observe that node 2 moves and continues to move

- +

diff --git a/docs/tutorials/tutorial5.md b/docs/tutorials/tutorial5.md index 7f2d151e..92337717 100644 --- a/docs/tutorials/tutorial5.md +++ b/docs/tutorials/tutorial5.md @@ -18,7 +18,7 @@ This section covers using the saved **scenario.xml** file to get and up and runn * Configure the Windows host VM to have a bridged network adapter

- +

* Make sure the **core-daemon** is running in a terminal ```shell @@ -30,15 +30,15 @@ This section covers using the saved **scenario.xml** file to get and up and runn ``` * Open the **scenario.xml** with the unassigned RJ45 node

- +

* Configure the RJ45 node name to use the bridged interface

- +

* After configuring the RJ45, run the scenario:

- +

* Double click node **n1** to open a terminal and add a route to the Windows host ```shell @@ -97,7 +97,7 @@ This section covers leveraging the gRPC script to get up and running. * Configure the Windows host VM to have a bridged network adapter

- +

* Make sure the **core-daemon** is running in a terminal ```shell @@ -114,7 +114,7 @@ This section covers leveraging the gRPC script to get up and running. ``` * In the **core-gui** connect to the running session that was created

- +

* Double click node **n1** to open a terminal and add a route to the Windows host ```shell diff --git a/docs/tutorials/tutorial6.md b/docs/tutorials/tutorial6.md index 6135d21e..46bb57ac 100644 --- a/docs/tutorials/tutorial6.md +++ b/docs/tutorials/tutorial6.md @@ -31,11 +31,11 @@ This section will cover running this sample tutorial that develops a scenario fi * Create three MDR nodes

- +

* Double click on each node for configuration, click the icon and set it to use the **drone.png** image

- +

* Use **Session -> Options** and set **Control Network 0** to **172.16.0.0./24** @@ -44,30 +44,30 @@ This section will cover running this sample tutorial that develops a scenario fi * Add a WLAN Node * Link the three prior MDR nodes to the WLAN node

- +

* Click play to start the scenario * Observe wireless links being created

- +

* Click stop to end the scenario * Right click the WLAN node and select **Edit -> Hide** * Now you can view the nodes in isolation

- +

### Changing Canvas Background * Click **Canvas -> Wallpaper** to set the background to terrain.png

- +

* Click play to start the scenario again * You now have a scenario with drone icons, terrain background, links displayed and hidden WLAN node

- +

## Adding Mobility @@ -80,7 +80,7 @@ This section will cover running this sample tutorial that develops a scenario fi ``` * Let it run to see the link break as the node 1 drone approches the right side

- +

* Repeat for other nodes, double click on **n2** and **n3** and run the demo.py script ```shell @@ -93,5 +93,5 @@ This section will cover running this sample tutorial that develops a scenario fi * Observe nodes moving in parallel tracks, when the far right is reached, the node will move down and then move to the left. When the far left is reached, the drone will move down and then move to the right.

- +

diff --git a/docs/tutorials/tutorial7.md b/docs/tutorials/tutorial7.md index 89a84555..2cc2f812 100644 --- a/docs/tutorials/tutorial7.md +++ b/docs/tutorials/tutorial7.md @@ -6,7 +6,7 @@ This tutorial will cover basic usage and some concepts one may want to use or leverage when working with and creating EMANE based networks.

- +

For more detailed information on EMANE see the following: @@ -52,11 +52,11 @@ between nodes in CORE. ``` * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**

- +

* You can now click on the **Start Session** button to run the scenario

- +

* Open a terminal on **n2** by double clicking it in the GUI * Run the following in **n2** terminal @@ -90,11 +90,11 @@ traffic being sent/received among many other uses. ``` * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**

- +

* You can now click on the **Start Session** button to run the scenario

- +

* Open a terminal on **n2** by double clicking it in the GUI * Open a terminal on **n3** by double clicking it in the GUI @@ -129,11 +129,11 @@ within the nodes of our scenario. ``` * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**

- +

* You can now click on the **Start Session** button to run the scenario

- +

* Open a terminal on **n2** by double clicking it in the GUI * Run the following in **n2** terminal @@ -179,11 +179,11 @@ using `tail -f` to observe the output of running software. ``` * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario_service.xml**

- +

* You can now click on the **Start Session** button to run the scenario

- +

* Open a terminal on **n2** by double clicking it in the GUI * Run the following in **n2** terminal diff --git a/mkdocs.yml b/mkdocs.yml index c2fbc03c..03504b13 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,7 @@ site_name: CORE Documentation +site_url: https://coreemu.github.io/core +repo_name: coreemu/core +repo_url: https://github.com/coreemu/core use_directory_urls: false theme: name: material