From f5922480233b567a36ab2314d27bd684becc8348 Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Fri, 11 Dec 2015 15:30:46 +0900 Subject: [PATCH] editorial fixes in apex docs - add gitignore entries - drop common files under docs/etc - fix documentation titles - fix doc8 violation (length of lines) - removal of '_sha1_' for doc tracking - removal of opnfv logo insertion Change-Id: Ib0b39704c115f896f62a8ed8ec52257fcf84d544 Signed-off-by: Ryota MIBU --- .gitignore | 5 ++ docs/etc/conf.py | 34 ------------ docs/etc/opnfv-logo.png | Bin 2829 -> 0 bytes docs/installation-instructions/index.rst | 25 ++------- .../installation-instructions.rst | 57 +++++++++++++-------- docs/release-notes/index.rst | 25 ++------- docs/release-notes/release-notes.rst | 14 ++--- 7 files changed, 50 insertions(+), 110 deletions(-) create mode 100644 .gitignore delete mode 100644 docs/etc/conf.py delete mode 100644 docs/etc/opnfv-logo.png diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..33a0451b --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +*~ +.*.sw? +/docs_build/ +/docs_output/ +/releng/ diff --git a/docs/etc/conf.py b/docs/etc/conf.py deleted file mode 100644 index c62a8610..00000000 --- a/docs/etc/conf.py +++ /dev/null @@ -1,34 +0,0 @@ -import datetime -import sys -import os - -try: - __import__('imp').find_module('sphinx.ext.numfig') - extensions = ['sphinx.ext.numfig'] -except ImportError: - # 'pip install sphinx_numfig' - extensions = ['sphinx_numfig'] - -# numfig: -number_figures = True -figure_caption_prefix = "Fig." - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'Apex', u'Apex Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'Apex: OPNFV Installer' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png deleted file mode 100644 index 1519503eba764f7a00877b9b8bdbbd37fd3707c6..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2829 zcmV+o3-a`dP)3)28sjxMC?FF++Bq$U6w!I|Q zuDk75d^``ll?O5~(CmjEDa)%lO*g>n_g{0#>mC}Gzk+T4rzf9>j53xroI0y~C_9nZ zRT`GLg0kl=wSC&o>6~=+jNzR71<#dp4To_2s0>t*!h`9cI?8$fX~Qs`rR1m400P?y z90%)qtm)id4ONiKpFsI}ZSK@iJ|1rbWk*!DU!d(zDwO-{0ftjgEE_w%;rV)uW5>yH z_exeI%QmujpMCMW4sNM^@?x)fLqOrhd{$9sTgQ`d%yCO<1Iu4R`O_B4UJp!A_62MX zv+dC{T~-}GLx+x;{ijz!sH5z=g`on8=PSHb0@Q#SaG3%t>jDJstyjW^fI6$;(C9VJ zM0+-BvHTu^?J(N@qDGm&V(fERuzosQRFSAa>*vWrfXJ0P?>aF7?>Ukt-*BC%M;idD zR})ZIu_ASxwrtR%$Ly%uwx-ywh|=kCy{aTtUB<3KB~XF4LO2cx3OQ&Lq?yxFVUVVp z0PEI0KSd4M#7I7+3(=OHPzP?sW6{8s*)F2yL=?p|oPJ~?`#D}}PV%!7PnCdm2ZMFk zW>V&_r_iP-9Vh7N0H%W`WFN{S(M)#H$rw-?2dl-hr#TA2Yp8sVw>mO79!D;2$j(C9 zzXy*$kkgBc&!cDaj~~4?%jjHLfvo_Dkm|Ke`S>rtaK&a?_58uB@A@?~_QQr_jA4r% zdo6L~(X+|q1$xR6wDO0o6BtGDy;|9Z8x6|M}356(@zSPXM%I z0Lusl0BW2ws#XdW$sw*J3o5uE4yIuhY3{5zlq-KbOpogcel|5sNqChP?l1?Huz=hO z3SQz!l7IoUeXMDtEbxn7>nNR~-uQD!D>F?@CkV2w46eFk7TlE;cNI&vfdHD!z_ z;-^n$4()d+RT3Nj{MYwKT=-mO$Li`vcN)ExjLy|D=p^S*?wC11I3%$KjPkiq9dic& zD1XFAINVJI`no{?+x)D;i*#V%#b0@^6+U-r5gc9;H_K&CRFHYaqspI@xpfrruA!jPbh-F;K8f!CJmzV zLU^o+ux2fL(BTYxUP&*N3GW6};H`XywCO?Ilt`dZ<@y1lkihEFYh6s!Cok30j1p@| zA*PCL7qX^OJS8L`Cu6zNLM4H9hooAZa`}@)!U0$bFcXy=K$sXnq37#@mx`sb0!4-h zfeLNEv8FIi;>F96e%vf)rl-oBrvk7d@g%V6_BVf7| zS9#?9)}X;>(XRIvx@+2+Chn!X=v9g*FSX8@n+oz`TlVDdw|;)?Qi7qA@?Piv_~kSp zz&N9Wpt$LZ@;^pTT&l=jY6Ntv!S~(!0Ta?)fhieeICo6MH?;1D1P$l8DC}dpX`5a~ zALHCbvB>*ip9$1haUlorIZDD~fXnDY0!+y*J);b_d;*^%R6~F(+Hr^uC68UD{MqKZ zyQ#Xn1?sk9Ky^fF%h*#DhDrm}69BE&;9s04v@Bh*TZP#G|!E+Ltr=`%PvYj2Zzz=`e#qSKRysVIIQ8#7S=4&P4ul z16;dqQw`0;M;E8cz{eLz0YHF%!Pmr+uvP zEG{6yZ@RHP70GX%dWv-m-sHwqFa7pYIh`H<7f$Y9Kl$`$%G98dx#an({(_lPu>y#%;AjQuVEuIY|;4s81w z#Z9+x0(6IfO6rah*C;7Q>2IAZ=A_a?j=YvVm5$`A=Xk(NjTP=x_bf}^Nv%B}fOYWx z-+$w4&SwN*t#-g;MKm(5?=ac1cqys-LMUztGL*=J3S^`(fvTgaU|;f5s$9OWDi9=I z1mFZYUJgA`4`A^D8XT2Wv*9PAp~W{FPBzFLX_p|XyY7n$pqd*&g_%8ysUC{WH7f9A z{3JO6UdmNy&)G-!?s6LASmZx|h}zZ%u#N#NN6`>B>G!PgVok2wT@V%84C-F@)68XM zGW#x-jYI{2;|u+SY#vZP0L5w;Oh|yY!hN&Wg1h=3z#0Nr=i>Rt>A6e%UKe}1!$6_^ zyY2!|KE8hcHS9CJx}hwxL|L2>K%N3nzR5u_jZQK!y-@we@hOeIt`Go*-YJIn>X1b) zcSps7k=C}`RwbZX)CLv6gAir@0^=XP_$PXk@XgyVD}%}x-+6=`IL7!&&~sY=n5Ri( zAYfsMQAU@D!Ifo|}iQURGX*Df~iL*>ymsNDu7Cs_;TR&=~wSP z9+T$^YHUmnj8!iS9oRm+UBb=MKy;;sk-xOF8-RYdS%B~4aLpauf1?pPG zRovzD3f;9+c%BL+9>i4$h%21{H=dY~eDumzpn~LuFa55oXP~o9(&iJ!@#?aOQNC#m ze6EpDkzx5k3v5joGO*Bjy-?:5000. This url is also the endpoint for the OPNFV Horizon Dashboard @@ -381,7 +392,8 @@ Once connected to the OPNFV Dashboard make sure the OPNFV target system is worki 1. In the left pane, click Compute -> Images, click Create Image. -2. Insert a name "cirros", Insert an Image Location ``http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img``. +2. Insert a name "cirros", Insert an Image Location + ``http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img``. 3. Select format "QCOW2", select Public, then click Create Image. @@ -393,7 +405,8 @@ Once connected to the OPNFV Dashboard make sure the OPNFV target system is worki 7. Now go to Project -> Compute -> Instances, click Launch Instance. -8. Enter Instance Name "first_instance", select Instance Boot Source "Boot from image", and then select Image Name "cirros". +8. Enter Instance Name "first_instance", select Instance Boot Source "Boot from image", + and then select Image Name "cirros". 9. Click Launch, status will cycle though a couple states before becoming "Active". @@ -424,21 +437,28 @@ Follow the instructions in the `Install Bare Metal Jumphost`_ section. Running ``opnfv-deploy`` ------------------------ -You are now ready to deploy OPNFV! ``opnfv-deploy`` has virtual deployment capability that includes all of the configuration nessesary to deploy OPNFV with no modifications. +You are now ready to deploy OPNFV! +``opnfv-deploy`` has virtual deployment capability that includes all of +the configuration nessesary to deploy OPNFV with no modifications. -If no modifications are made to the included configurations the target environment will deploy with the following architecture: +If no modifications are made to the included configurations the target environment +will deploy with the following architecture: - 1 Instack VM - - The option of 3 control and 2 compute VMs (HA Deploy / default) or 1 control and 1 compute VM (Non-HA deploy / pass -n) + - The option of 3 control and 2 compute VMs (HA Deploy / default) + or 1 control and 1 compute VM (Non-HA deploy / pass -n) - - 2 networks, one for provisioning, internal API, storage and tenant networking traffic and a second for the external network + - 2 networks, one for provisioning, internal API, + storage and tenant networking traffic and a second for the external network Follow the steps below to execute: 1. ``opnfv-deploy --virtual [ --no-ha ]`` -2. It will take approximately 30 minutes to stand up instack, define the target virtual machines, configure the deployment and execute the deployment. You will notice different outputs in your shell. +2. It will take approximately 30 minutes to stand up instack, + define the target virtual machines, configure the deployment and execute the deployment. + You will notice different outputs in your shell. 3. When the deployment is complete you will see "Overcloud Deployed" @@ -513,10 +533,3 @@ RDO Manager :Authors: Tim Rozet (trozet@redhat.com) :Authors: Dan Radez (dradez@redhat.com) :Version: 1.0 - -**Documentation tracking** - -Revision: _sha1_ - -Build date: _date_ - diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst index 17436e2b..1f723960 100644 --- a/docs/release-notes/index.rst +++ b/docs/release-notes/index.rst @@ -1,16 +1,6 @@ -.. OPNFV Release Engineering documentation, created by - sphinx-quickstart on Tue Jun 9 19:12:31 2015. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - -Apex Table of Contents -====================== +************************ +OPNFV Apex Release Notes +************************ Contents: @@ -19,12 +9,3 @@ Contents: :maxdepth: 4 release-notes.rst - -Indices and tables -================== - -* :ref:`search` - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst index 2e535412..cfb0db59 100644 --- a/docs/release-notes/release-notes.rst +++ b/docs/release-notes/release-notes.rst @@ -1,6 +1,6 @@ -============================================================================================= +============================================================================================ OPNFV Release Notes for the Bramaputra release of OPNFV when using Apex as a deployment tool -============================================================================================= +============================================================================================ .. contents:: Table of Contents @@ -65,7 +65,8 @@ node. - Documentation is built by Jenkins - .iso image is built by Jenkins -- Jenkins deploys a Bramaputra release with the Apex deployment toolchain baremetal, which includes 3 control+network nodes, and 2 compute nodes. +- Jenkins deploys a Bramaputra release with the Apex deployment toolchain baremetal, + which includes 3 control+network nodes, and 2 compute nodes. Release Data ============ @@ -220,10 +221,3 @@ http://wiki.opnfv.org/releases/bramaputra :Authors: Tim Rozet (trozet@redhat.com) :Authors: Dan Radez (dradez@redhat.com) :Version: 1.0.0 - -**Documentation tracking** - -Revision: _sha1_ - -Build date: _date_ - -- 2.16.6