-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
5 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,7 @@ | ||
F5 Agility Lab Template | ||
======================= | ||
F5 Agility OpenStack Lab | ||
======================== | ||
|
||
Introduction | ||
------------ | ||
|
||
This repo contains a template that should be used when creating lab | ||
documentation for F5's Agility Labs. | ||
|
||
Setup | ||
----- | ||
|
||
#. Download or ``git clone`` the f5-agility-lab-template | ||
#. Download and install Docker CE (https://docs.docker.com/engine/installation/) | ||
#. Build the sample docs ``./containthedocs-build.sh``. The first time you build | ||
a container (~1G in size) will be downloaded from Docker Hub. | ||
#. Open the ``docs/_build/html/index.html`` file on you system in a web browser | ||
|
||
Configuration & Use | ||
------------------- | ||
|
||
To use this template: | ||
|
||
#. Copy contents of this repo to a new directory ``cp -Rf . /path/to/your/docs`` | ||
#. ``cd /path/to/your/docs`` | ||
#. Edit ``docs/conf.py`` | ||
#. Modify the following lines: | ||
|
||
- ``classname = "Your Class Name"`` | ||
- ``github_repo = "https://github.com/f5devcentral/your-class-repo"`` | ||
|
||
#. Build docs ``./containthedocs-build.sh`` (*see Build Scripts below*) | ||
#. Open the ``docs/_build/html/index.html`` file on you system in a web browser | ||
#. Edit the ``*.rst`` files as needed for your class | ||
#. Rebuild docs as needed using ``./containthedocs-build.sh`` | ||
|
||
Converting from Microsoft Word | ||
------------------------------ | ||
|
||
To convert a ``.docx`` file from Microsoft Work to reStructuredText: | ||
|
||
#. Copy your ``.docx`` file into the f5-agility-lab-template directory | ||
#. Run ``./containthedocs-convert.sh <filename.docx>`` | ||
#. Your converted file will be named ``filename.rst`` | ||
#. Images in your document will be extracted and placed in the ``media`` | ||
directory | ||
|
||
.. WARNING:: While the document has been converted to rST format you will still | ||
need to refactor the rST to use the structure implemented in this template. | ||
|
||
.. _scripts: | ||
|
||
Build Scripts | ||
------------- | ||
|
||
The repo includes build scripts for common operations: | ||
|
||
- ``containthedocs-bash.sh``: Run to container with a BASH prompt | ||
- ``containthedocs-build.sh``: Build HTML docs using ``make -C docs html`` to | ||
``docs/_build/html`` | ||
- ``containthedocs-clean.sh``: Clean the build director using | ||
``make -C docs clean`` | ||
- ``containthedocs-convert.sh``: Convert a Word ``.docx`` file to rST | ||
- ``containthedocs-pdf.sh``: Build PDF docs using ``make -C docs latexpdf`` to | ||
``docs/_build/latex`` | ||
|
||
|
||
http://f5-agility-labs-openstack.rtfd.io/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters