diff options
| author |   opensource-tnbt <sridhar.rao@spirent.com> | 2020-11-30 23:30:03 +0530 |
|---|---|---|
| committer | opensource-tnbt <sridhar.rao@spirent.com> | 2020-11-30 23:31:22 +0530 |
| commit | e0a327b8e02c9202732752cbb14ca4900c49bc52 (patch) | |
| tree | 6dbdcf171ace5d1084f719e609f557646e5f293c /docs/pdf | |
| parent | a848ae411a7e3a69bf00042166392c5a0d45a7e0 (diff) | |
DOCS: Update the Documentation.
This patch updates the documentation for Jerma.
Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com>
Change-Id: Ic0d61a74b1c8d31c8facaa16837894fc816ac739
Diffstat (limited to 'docs/pdf')
| -rw-r--r-- | docs/pdf/userguide.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/pdf/userguide.rst b/docs/pdf/userguide.rst new file mode 100644 index 0000000..2394888 --- /dev/null +++ b/docs/pdf/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. |