aboutsummaryrefslogtreecommitdiffstats
path: root/sdv/docs/pdf
diff options
context:
space:
mode:
authoropensource-tnbt <sridhar.rao@spirent.com>2020-09-10 12:23:34 +0530
committerSridhar Rao <sridhar.rao@spirent.com>2020-09-12 03:37:23 +0000
commit86d4114ab61f9cb00c1d01f91e81e9a38c6ba2f6 (patch)
tree5d5048528f9c5a15b372e9c889a276b5a3721de2 /sdv/docs/pdf
parent27fff834bee372c53e1b5d222c398543ac3f34aa (diff)
SDV: Platform Description Implementation.
This patch includes PDF Template and a tool to create PDF. Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com> Change-Id: Ib702ff42352d584cb9146ff1959258c558e06615
Diffstat (limited to 'sdv/docs/pdf')
-rw-r--r--sdv/docs/pdf/user/userguide.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/sdv/docs/pdf/user/userguide.rst b/sdv/docs/pdf/user/userguide.rst
new file mode 100644
index 0000000..2394888
--- /dev/null
+++ b/sdv/docs/pdf/user/userguide.rst
@@ -0,0 +1,29 @@
+*******************************************
+Platform Descriptor File (PDF) : User Guide
+*******************************************
+
+Using the PDF template
+######################
+Please follow these steps.
+
+* Go to sdv/pdf/template folder.
+* Make a copy of it using site name ::
+
+
+ cp pdf_template.json <sitename_pdf>.json.
+
+* Fill all the values.
+
+* Use the <sitename_pdf>.json with sdvconfig tool to extrapolate the pdf. Refer to sdvconfig documentation.
+* PDF is ready to use.
+
+Using GUI to create platform-description
+########################################
+Please follow these steps.
+
+* Go to sdv/pdf/site folder.
+* Open index.html with any browser.
+* Follow the guidelines and fill all the values.
+* Click Submit and Download. File named sitepdf.json will be downloaded.
+* Use the sitepdf.json with sdvconfig tool to extrapolate the pdf. Refer to sdvconfig documentation.
+* PDF is ready to use.