aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/userguide/pdf
diff options
context:
space:
mode:
authoropensource-tnbt <sridhar.rao@spirent.com>2020-10-27 08:19:07 +0530
committeropensource-tnbt <sridhar.rao@spirent.com>2020-10-27 08:21:39 +0530
commita848ae411a7e3a69bf00042166392c5a0d45a7e0 (patch)
treee4036c81351cdf76ab4e0bce1c7d7a977436ca41 /docs/release/userguide/pdf
parentf12039ae1fb9ed773ddf3d8000c6645e5900c48e (diff)
DOCS: Re-Organize Documentation.
This patch organizes documentation for Jerma Release. Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com> Change-Id: I653c8c4b4e0092059f19314631a0fcab4941e134
Diffstat (limited to 'docs/release/userguide/pdf')
-rw-r--r--docs/release/userguide/pdf/user/userguide.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/release/userguide/pdf/user/userguide.rst b/docs/release/userguide/pdf/user/userguide.rst
new file mode 100644
index 0000000..2394888
--- /dev/null
+++ b/docs/release/userguide/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.