Initial commit of Sphinx docs
[vpp.git] / docs / gettingstarted / writingdocs / todo.rst
1 .. _todo:
2
3 *****
4 To Do
5 *****
6
7 This section describes pieces of these documents that need some work.
8
9 All Sections
10 ============
11
12 All the sections need to be spell checked.
13
14 Checked for guidelines.
15
16 :ref:`vhost`
17 ============
18
19 :ref:`vhosttopo`
20 ----------------
21
22 Get a better topology picture.
23
24 :ref:`vhost02`
25 --------------
26
27 The XML file refers to an iso image, come up with a procedure to build that image.
28 That should work when used with a cloud image. It should also be mentioned where
29 to get a cloud image.
30
31 It is mentioned that a queue size of 256 is not large enough. Come up wit a procedure
32 to change the queue size.
33
34
35 :ref:`users`
36 ============
37
38 The getting started users guide needs an overview
39
40 :ref:`cmdreference`
41 ===================
42
43 This section should be references to the doxygen links. The doxygen links will need to be cleaned up.
44 This section could be a quick reference only using commands we have tested.
45
46 :ref:`progressivevpp`
47 =====================
48
49 This section needs work. It needs to be split up and tested.
50
51 :ref:`vswitchrtr`
52 =================
53
54 Needs some instructions or be removed.
55
56 :ref:`jvppjar`
57 ==============
58
59 Not sure what value this provides.
60