From 06dcd45ff81e06bc8cf40ed487c0b2652d346a5a Mon Sep 17 00:00:00 2001 From: John DeNisco Date: Thu, 26 Jul 2018 12:45:10 -0400 Subject: Initial commit of Sphinx docs Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco --- .../AllTrainingContent/DayFour/4-1-mapinvpp.rst | 24 ++++++++++++ .../DayFour/4-2-project-onelisp.rst | 23 +++++++++++ .../DayFour/4-3-csit-performancetesting.rst | 24 ++++++++++++ .../AllTrainingContent/DayFour/index.rst | 14 +++++++ .../AllTrainingContent/DayOne/1-2-vppoverview.rst | 28 ++++++++++++++ .../DayOne/1-3-containerdemo.rst | 29 ++++++++++++++ .../DayOne/1-4-codecontributionmechanics.rst | 28 ++++++++++++++ .../DayOne/1-5-dpdkintroduction.rst | 28 ++++++++++++++ .../AllTrainingContent/DayOne/index.rst | 17 ++++++++ .../DayThree/2-4-more-macswap.rst | 24 ++++++++++++ .../DayThree/3-1-buffer-metadata.rst | 24 ++++++++++++ .../3-2-multicorewalkthruanddpdkintegration.rst | 24 ++++++++++++ .../DayThree/3-3-dpdkoptimizations.rst | 24 ++++++++++++ .../AllTrainingContent/DayThree/index.rst | 17 ++++++++ .../DayThree/preworkandscripts.rst | 24 ++++++++++++ .../DayThree/supplemental-graphwiringnotes.rst | 24 ++++++++++++ .../DayTwo/2-1-dataplane-codeoverview.rst | 4 ++ .../AllTrainingContent/DayTwo/2-2-vppinit.rst | 4 ++ .../AllTrainingContent/DayTwo/2-3-eventlogger.rst | 4 ++ .../DayTwo/2-4-macswapbreakdown.rst | 6 +++ .../AllTrainingContent/DayTwo/index.rst | 15 ++++++++ .../DayTwo/preworkandscripts.rst | 34 ++++++++++++++++ .../fdioTraining/AllTrainingContent/index.rst | 45 ++++++++++++++++++++++ 23 files changed, 488 insertions(+) create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayFour/4-1-mapinvpp.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayFour/4-2-project-onelisp.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayFour/4-3-csit-performancetesting.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayFour/index.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayOne/1-2-vppoverview.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayOne/1-3-containerdemo.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayOne/1-4-codecontributionmechanics.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayOne/1-5-dpdkintroduction.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayOne/index.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayThree/2-4-more-macswap.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayThree/3-1-buffer-metadata.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayThree/3-2-multicorewalkthruanddpdkintegration.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayThree/3-3-dpdkoptimizations.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayThree/index.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayThree/preworkandscripts.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayThree/supplemental-graphwiringnotes.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayTwo/2-1-dataplane-codeoverview.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayTwo/2-2-vppinit.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayTwo/2-3-eventlogger.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayTwo/2-4-macswapbreakdown.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayTwo/index.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/DayTwo/preworkandscripts.rst create mode 100644 docs/events/fdioTraining/AllTrainingContent/index.rst (limited to 'docs/events/fdioTraining/AllTrainingContent') diff --git a/docs/events/fdioTraining/AllTrainingContent/DayFour/4-1-mapinvpp.rst b/docs/events/fdioTraining/AllTrainingContent/DayFour/4-1-mapinvpp.rst new file mode 100644 index 00000000000..298b6daaae8 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayFour/4-1-mapinvpp.rst @@ -0,0 +1,24 @@ +.. _4-1-mapinvpp: + +.. toctree:: + +############################## +FD.io DevBoot: 4.1: Map in VPP +############################## + +Event +----- + +This presentation was held during the on th, 201. + +Speakers +-------- + + +Slideshow +--------- + +Video +----- + + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayFour/4-2-project-onelisp.rst b/docs/events/fdioTraining/AllTrainingContent/DayFour/4-2-project-onelisp.rst new file mode 100644 index 00000000000..8d4dcaf2354 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayFour/4-2-project-onelisp.rst @@ -0,0 +1,23 @@ +.. _4-2-project-onelisp: + +.. toctree:: + +##################################### +FD.io DevBoot: 4.2: Project: ONE LISP +##################################### + +Event +----- + +This presentation was held during the on th, 201. + +Speakers +-------- + + +Slideshow +--------- + +Video +----- + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayFour/4-3-csit-performancetesting.rst b/docs/events/fdioTraining/AllTrainingContent/DayFour/4-3-csit-performancetesting.rst new file mode 100644 index 00000000000..5c59f09c02f --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayFour/4-3-csit-performancetesting.rst @@ -0,0 +1,24 @@ +.. _4-3-csit-performancetesting: + +.. toctree:: + +############################################# +FD.io DevBoot: 4.3 CSIT + Performance testing +############################################# + +Event +----- + +This presentation was held during the on th, 201. + +Speakers +-------- + + +Slideshow +--------- + +Video +----- + + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayFour/index.rst b/docs/events/fdioTraining/AllTrainingContent/DayFour/index.rst new file mode 100644 index 00000000000..eaf58cd10c3 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayFour/index.rst @@ -0,0 +1,14 @@ +.. _DayFour: + +.. toctree:: + +######## +Day Four +######## + +.. toctree:: + :maxdepth: 1 + + 4-1-mapinvpp.rst + 4-2-project-onelisp.rst + 4-3-csit-performancetesting.rst diff --git a/docs/events/fdioTraining/AllTrainingContent/DayOne/1-2-vppoverview.rst b/docs/events/fdioTraining/AllTrainingContent/DayOne/1-2-vppoverview.rst new file mode 100644 index 00000000000..ea9f69f8941 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayOne/1-2-vppoverview.rst @@ -0,0 +1,28 @@ +.. _1-2-vppoverview: + +.. toctree:: + +=============================== +FD.io DevBoot: 1.2 VPP overview +=============================== + +Event +----- + +This presentation was held during the FD.io Training/Hackfest on April 5th, 2016. + +Speakers +-------- + +Dave Barach and Keith Burns + +Slideshow +--------- + +`Presentation Powerpoint `_ + +Video +----- + +`DevBoot Presentation `_ + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayOne/1-3-containerdemo.rst b/docs/events/fdioTraining/AllTrainingContent/DayOne/1-3-containerdemo.rst new file mode 100644 index 00000000000..d219d950a70 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayOne/1-3-containerdemo.rst @@ -0,0 +1,29 @@ +.. _1-3-containerdemo: + +.. toctree:: + +================================= +FD.io DevBoot: 1.3 Container Demo +================================= + +Event +----- + +This presentation was held during the FD.io Training/Hackfest on April 5th, 2016. + +Speakers +-------- + +Nikos Bregiannis + + +Slideshow +--------- + +`Presentation Powerpoint `_ + +Video +----- + +`DevBoot Presentation `_ + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayOne/1-4-codecontributionmechanics.rst b/docs/events/fdioTraining/AllTrainingContent/DayOne/1-4-codecontributionmechanics.rst new file mode 100644 index 00000000000..053490aa6d5 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayOne/1-4-codecontributionmechanics.rst @@ -0,0 +1,28 @@ +.. _1-4-codecontributionmechanics: + +.. toctree:: + +============================================== +FD.io DevBoot: 1.4 Code Contribution Mechanics +============================================== + +Event +----- + +This presentation was held during the FD.io Training/Hackfest on April 5th, 2016. + +Speakers +-------- + +Keith Burns + +Slideshow +--------- + +`Presentation Powerpoint `_ + +Video +----- + +`DevBoot Presentation `_ + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayOne/1-5-dpdkintroduction.rst b/docs/events/fdioTraining/AllTrainingContent/DayOne/1-5-dpdkintroduction.rst new file mode 100644 index 00000000000..eec0da1b1b2 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayOne/1-5-dpdkintroduction.rst @@ -0,0 +1,28 @@ +.. _1-5-dpdkintroduction: + +.. toctree:: + +==================================== +FD.io DevBoot: 1.5 DPDK Introduction +==================================== + +Event +----- + +This presentation was held during the FD.io Training/Hackfest on April 5th, 2016. + +Speakers +-------- + +Cristian Dumitrescu + +Slideshow +--------- + +`Presentation Powerpoint `_ + +Video +----- + +`DevBoot Presentation `_ + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayOne/index.rst b/docs/events/fdioTraining/AllTrainingContent/DayOne/index.rst new file mode 100644 index 00000000000..62f4905f284 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayOne/index.rst @@ -0,0 +1,17 @@ +.. _DayOne: + +.. toctree:: + +####### +Day One +####### + +List of FD.io presentations that were held in the FD.io Training/Hackfest on April 5th, 2016. + +.. toctree:: + :maxdepth: 1 + + 1-2-vppoverview.rst + 1-3-containerdemo.rst + 1-4-codecontributionmechanics.rst + 1-5-dpdkintroduction.rst \ No newline at end of file diff --git a/docs/events/fdioTraining/AllTrainingContent/DayThree/2-4-more-macswap.rst b/docs/events/fdioTraining/AllTrainingContent/DayThree/2-4-more-macswap.rst new file mode 100644 index 00000000000..c8de60f3a09 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayThree/2-4-more-macswap.rst @@ -0,0 +1,24 @@ +.. _2-4-more-macswap: + +.. toctree:: + +################ +2 4 more macswap +################ + +Event +----- + +This presentation was held during the on th, 201. + +Speakers +-------- + + +Slideshow +--------- + +Video +----- + + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayThree/3-1-buffer-metadata.rst b/docs/events/fdioTraining/AllTrainingContent/DayThree/3-1-buffer-metadata.rst new file mode 100644 index 00000000000..ac3a1a60c9c --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayThree/3-1-buffer-metadata.rst @@ -0,0 +1,24 @@ +.. _3-1-buffer-metadata: + +.. toctree:: + +################### +3 1 buffer metadata +################### + +Event +----- + +This presentation was held during the on th, 201. + +Speakers +-------- + + +Slideshow +--------- + +Video +----- + + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayThree/3-2-multicorewalkthruanddpdkintegration.rst b/docs/events/fdioTraining/AllTrainingContent/DayThree/3-2-multicorewalkthruanddpdkintegration.rst new file mode 100644 index 00000000000..18f12909a83 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayThree/3-2-multicorewalkthruanddpdkintegration.rst @@ -0,0 +1,24 @@ +.. _3-2-multicorewalkthruanddpdkintegration: + +.. toctree:: + +############## +3 2 multi core +############## + +Event +----- + +This presentation was held during the on th, 201. + +Speakers +-------- + + +Slideshow +--------- + +Video +----- + + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayThree/3-3-dpdkoptimizations.rst b/docs/events/fdioTraining/AllTrainingContent/DayThree/3-3-dpdkoptimizations.rst new file mode 100644 index 00000000000..e3725f57687 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayThree/3-3-dpdkoptimizations.rst @@ -0,0 +1,24 @@ +.. _3-3-dpdkoptimizations: + +.. toctree:: + +################## +DPDK Optimizations +################## + +Event +----- + +This presentation was held during the on th, 201. + +Speakers +-------- + + +Slideshow +--------- + +Video +----- + + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayThree/index.rst b/docs/events/fdioTraining/AllTrainingContent/DayThree/index.rst new file mode 100644 index 00000000000..547299cd766 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayThree/index.rst @@ -0,0 +1,17 @@ +.. _DayThree: + +.. toctree:: + +######### +Day Three +######### + +.. toctree:: + :maxdepth: 1 + + preworkandscripts.rst + 2-4-more-macswap.rst + 3-1-buffer-metadata.rst + 3-2-multicorewalkthruanddpdkintegration.rst + 3-3-dpdkoptimizations.rst + supplemental-graphwiringnotes.rst diff --git a/docs/events/fdioTraining/AllTrainingContent/DayThree/preworkandscripts.rst b/docs/events/fdioTraining/AllTrainingContent/DayThree/preworkandscripts.rst new file mode 100644 index 00000000000..de84facb9f1 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayThree/preworkandscripts.rst @@ -0,0 +1,24 @@ +.. _preworkandscripts: + +.. toctree:: + +######## +Pre Work +######## + +Event +----- + +This presentation was held during the on th, 201. + +Speakers +-------- + + +Slideshow +--------- + +Video +----- + + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayThree/supplemental-graphwiringnotes.rst b/docs/events/fdioTraining/AllTrainingContent/DayThree/supplemental-graphwiringnotes.rst new file mode 100644 index 00000000000..a2fae2da955 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayThree/supplemental-graphwiringnotes.rst @@ -0,0 +1,24 @@ +.. _supplemental-graphwiringnotes.rst: + +.. toctree:: + +############ +Supplemental +############ + +Event +----- + +This presentation was held during the on th, 201. + +Speakers +-------- + + +Slideshow +--------- + +Video +----- + + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-1-dataplane-codeoverview.rst b/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-1-dataplane-codeoverview.rst new file mode 100644 index 00000000000..f25fe1f293e --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-1-dataplane-codeoverview.rst @@ -0,0 +1,4 @@ +.. _2-1-dataplane-codeoverview: + +.. toctree:: + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-2-vppinit.rst b/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-2-vppinit.rst new file mode 100644 index 00000000000..35d3fd3a14d --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-2-vppinit.rst @@ -0,0 +1,4 @@ +.. _2-2-vppinit: + +.. toctree:: + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-3-eventlogger.rst b/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-3-eventlogger.rst new file mode 100644 index 00000000000..a0b9130c0c5 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-3-eventlogger.rst @@ -0,0 +1,4 @@ +.. _2-3-eventlogger: + +.. toctree:: + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-4-macswapbreakdown.rst b/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-4-macswapbreakdown.rst new file mode 100644 index 00000000000..a0f6753e7c8 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayTwo/2-4-macswapbreakdown.rst @@ -0,0 +1,6 @@ +.. _2_4__macswapbreakdown: + +================== +Mac Swap Breakdown +================== + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayTwo/index.rst b/docs/events/fdioTraining/AllTrainingContent/DayTwo/index.rst new file mode 100644 index 00000000000..5554667255b --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayTwo/index.rst @@ -0,0 +1,15 @@ +.. _DayTwo: + +======= +Day Two +======= + +.. toctree:: + :maxdepth: 1 + + preworkandscripts.rst + 2-1-dataplane-codeoverview.rst + 2-2-vppinit.rst + 2-3-eventlogger.rst + 2-4-macswapbreakdown.rst + diff --git a/docs/events/fdioTraining/AllTrainingContent/DayTwo/preworkandscripts.rst b/docs/events/fdioTraining/AllTrainingContent/DayTwo/preworkandscripts.rst new file mode 100644 index 00000000000..f2292148cf3 --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/DayTwo/preworkandscripts.rst @@ -0,0 +1,34 @@ +.. _preworkandscripts: + +.. toctree:: + +######################################### +FD.io DevBoot: Day 2 Pre-work and scripts +######################################### + +Event +----- + +This presentation was held on April, 2016. + +Preparing for Day 2 +------------------- + +#. :ref:`vppcontainers` +#. Build vagrant environment + +.. code-block:: console + + $ vagrant ssh + $ sudo su + $ wget -O /vagrant/netns.sh "https://tinyurl.com/devboot-netns" + $ wget -O /vagrant/macswap.conf "https://tinyurl.com/devboot-macswap-conf" + $ wget -O ~/.gdbinit "https://tinyurl.com/devboot-gdbinit" + +.. note:: + + For Init section: + Breakpoints + High-level chicken-scrawl of init + + diff --git a/docs/events/fdioTraining/AllTrainingContent/index.rst b/docs/events/fdioTraining/AllTrainingContent/index.rst new file mode 100644 index 00000000000..2fe068aabef --- /dev/null +++ b/docs/events/fdioTraining/AllTrainingContent/index.rst @@ -0,0 +1,45 @@ +.. _AllTrainingContent: + +.. toctree:: + +##################### +All Technical Content +##################### + +As each session is delivered, the content will be provided here initially as PDF, with links to Videos, other content, to come as available. +These presentations were held during the FD.io Training/Hackfest on April 5th, 2016. + +======= +Day One +======= + +.. toctree:: + + DayOne/index.rst + +======= +Day Two +======= + +.. toctree:: + + DayTwo/index.rst + +========= +Day Three +========= + +.. toctree:: + + DayThree/index.rst + +======== +Day Four +======== + +.. toctree:: + + DayFour/index.rst + + + -- cgit 1.2.3-korg