from @pjbreaux:

In docs/guides/includes/os_ve_deploy_config-mgmt-network.rst:

> @@ -0,0 +1,74 @@
> +.. _os_ve_deploy_config-mgmt-network:
> +
> +1. Create a network to be used for the BIG-IP management interface.

maybe a quick blurb about what we mean when we say 'management'. As I understand it, it is used for control traffic, such as ssh access and VE configuration over REST.

see https://help.github.com/articles/using-jekyll-plugins-with-github-pages/
Jekyll-sitemap

OpenStack Release

Kilo +

Description

I need to update the download link for each OpenStack release version (the latest link currently in the doc now points to mitaka instead of liberty)

Kilo:
https://repos.fedorapeople.org/repos/openstack/openstack-kilo/rdo-release-kilo-1.noarch.rpm

Liberty:
https://repos.fedorapeople.org/repos/openstack/openstack-liberty/rdo-release-liberty-1.noarch.rpm

Mitaka:
https://repos.fedorapeople.org/repos/openstack/openstack-mitaka/rdo-release-mitaka-1.noarch.rpm

1. The items don't link to the correct place on the page.
2. The sidebar line wrap/indent need to be corrected.
   

per discussion with Faruk - OpenStack plugin is compatible with BIG-IP® 11.5.2+. Need to update support matrix.

OpenStack Release

Kilo +

Description

The user guides present a lot of the same information. Instead of re-writing the information for each guide, it should be reused from a single source.

Structure and format should follow F5 Tech Comms content reuse best practices (using maps and mini-maps, prefacing file names with types - topic, ref, or concept).

compat matrix table isn't rendering correctly
add email address

https://travis-ci.com/jputrino/f5-openstack-docs/builds/19163410

Certain image files are causing Jekyll to throw the following error:

Liquid Exception: invalid byte sequence in UTF-8 in _includes/f5-os-agent/assets/lbaas-agent-status.png, included in m_install_lbaas_plugin_agent.md
jekyll 2.4.0 | Error:  invalid byte sequence in UTF-8

see jekyll/jekyll#2592 for reference

There needs to be documentation for the minimum specs for the different image types that are available from F5 when they are deployed in OpenStack. For example the following QCOW images will have some minimum requirements for Disk, Memory, CPU.

BIGIP-12.0.0.0.0.606.ALL.qcow2.zip
BIGIP-12.0.0.0.0.606.LTM.qcow2.zip
BIGIP-12.0.0.0.0.606.LTM_1SLOT.qcow2.zip

The Device Service Clustering link is targeting includes/ve_clustering_overview instead of the DSC section in the deploy doc.

http://f5-openstack-docs.readthedocs.org/en/1.0/guides/deploy_ve_openstack.html#create-vlans

OpenStack Release

Kilo +

Description

I'd like to add the htmlproofer to the travis build to test the docs after sphinx builds them.

$ htmlproofer --allow-hash-href --check-html --file-ignore docs/_build/search.html docs/_build

README:

|slack badge|

.. |slack badge| image:: https://f5-openstack-slack.herokuapp.com/badge.svg
    :target: https://f5-openstack-slack.herokuapp.com/
    :alt: Slack

index.rst:

.. raw:: html

    <script async defer src="https://f5-openstack-slack.herokuapp.com/slackin.js"></script>

I need to fix the versioning and push the changes to the liberty branch.

new text:

Maintenance and F5 Technical Support of the F5 code is provided only if the software (i) is unmodified; and (ii) has been marked as F5 Supported in SOL80012344, (https://support.f5.com/kb/en-us/solutions/public/k/80/sol80012344.html). Support will only be provided to customers who have an existing support contract, purchased separately, subject to F5’s support policies available at http://www.f5.com/about/guidelines-policies/ and http://askf5.com.

OpenStack Release

n/a

Description

Turn on the Read the Docs webhook in GitHub.

I want to add an 'example' box to the rtd template (similar to the note, caution, tip, etc. boxes).

OpenStack Release

Liberty, Mitaka

Description

There are some different requirements for the answers file in Mitaka and possibly Liberty (in the os deploy guide). These changes affect the instructions in the configuring the OVS bridge section of the os configuration guide, so both will need to be updated accordingly.

See:
https://www.rdoproject.org/install/quickstart/
https://www.rdoproject.org/networking/neutron-with-existing-external-network

We deleted the f5-openstack-lbaasv2-plugin repo; it needs to be removed from the docs landing page as well.

• Title: A short but descriptive summary of the issue, whether it be a bug or enhancement.
• Labels: Click on the gear icon and give us some direction on the type of issue you are filing.
• Milestone: Leave this field empty.
• Assignee: If you're not fixing the issue, leave this field empty.
• Attachments: For bugs, attach the agent log and configuration files
  • /etc/neutron/f5-oslbaasv1-agent.ini
  • /var/log/neutron/f5-oslbaasv1-agent.log
• Details: For enhancements, fill out the template below.

OpenStack Release

Kilo

Description

The Heat templates for preparing a BIG-IP® VE image and for deploying VE in OpenStack are now officially supported. The deployment guide here needs to be updated with references to the Heat documentation.

Now that the repo is public, travis can push a build to the gh-pages branch. I'd like to set this up so any changes made on the develop branch will automatically get pushed to gh-pages. Only develop and gh-pages are to be used for gh-pages going forward.

'Best practices' doc request:

• how a customer should approach LBaaS config migration between two VEs when they want to deploy a Newer F5 VE
• how to migrate something to an appliance in case of a "RMA", Damage VE that needs to be replaced, etc… *

*needs clarification, ask Nicholas Menant

OpenStack Release

n/a

Description

Change the travis script to use the command that will treat sphinx warnings as errors.

sphinx-build -W docs/ docs/_build/

Add the blob to conf.py that will ignore the external image warnings.

# Ignore external image warnings
import sphinx.environment
from docutils.utils import get_source_line
def _warn_node(self, msg, node):
    if not msg.startswith('nonlocal image URI found:'):
        self._warnfunc(msg, '%s:%s' % get_source_line(node))
sphinx.environment.BuildEnvironment.warn_node = _warn_node

OpenStack Release

Kilo

Description

Change the travis build script to use the command that treats sphinx warnings as errors.

sphinx-build -W docs/ docs/_build/

Add the following to conf.py to exclude the external image warnings:

# Ignore external image warnings
import sphinx.environment
from docutils.utils import get_source_line
def _warn_node(self, msg, node):
if not msg.startswith('nonlocal image URI found:'):
self._warnfunc(msg, '%s:%s' % get_source_line(node))
sphinx.environment.BuildEnvironment.warn_node = _warn_node

kramdown with gfm is not converting some special characters correctly.

To try:

• taking out the gfm extension
• adding a new markdown converter plugin for pandoc

Settings -> Webhooks & Services -> Add Service -> Read The Docs
test payload

1. Create new read the docs site for this repo.
   • Remove Jekyll configs, dirs, etc. (keep css)
   • Configure sphinx
   • Refactor docs which are reusing content into single continuous files
   • Convert all docs to rst and review for conversion errors.
   • Move docs to project repos as appropriate for content (where applicable)
2. Refactor the index.html.
   • Links to project rtd sites
   • About Us / Contact Us page

Build #10 -- fatal: Authentication failed for 'https://@github.com/F5Networks/f5-openstack-docs/'

OpenStack Release

Kilo (LBaaSv1) and Liberty (LBaaSv2)

Description

We do not currently have instructions for how to use multiple agents on one host. See this post on Hive. Specific request is for Ubuntu, but we need to provide instructions for both CentOS and Ubuntu if they differ.

This is covered in part (http://f5-openstack-lbaasv1.readthedocs.org/en/liberty/f5-oslbaasv1-readme.html#running-multiple-agents-on-the-same-host) but I need to vet and enhance the instructions. This should probably be a stand-alone doc for each lbaas project.

Update the deploy/config guides as needed for Liberty.

check reference to figure 1 - not displaying after site update on 1/21/16

_includes/footer.html needs to be edited so it consistently sticks to the bottom of the page

OpenStack Release

Kilo +

Description

• every reference to an actual BIG-IP (not a BigIP object) needs to be in caps and have the appropriate trademark.
• remove the 'device' after BIG-IP (it's normally used to refer to hardware, and we're referring to either hardware or VE).

Work from the F5-TMOS-VE-Deployment guide to document F5 onboard.

Commit_7bb1470_travislog.txt

Deployment to S3 is failing:
"The request signature we calculated does not match the signature you provided. Check your key and signing method. (Aws::S3::Errors::SignatureDoesNotMatch)"

Per https://github.com/blog/2111-issue-and-pull-request-templates -- we can now add issue and pull request templates. I need to add these to this repo.

Add a 'quick start' guide to setting up an OpenStack environment with F5 services.

When page is resized, header line wraps outside of its container.

content at the bottom of a page using the docs_page layout is being cut off by the footer.

http://f5-openstack-dev-lbaas.s3-website-us-west-2.amazonaws.com/map_install_lbaas_plugin/index.html

A setting in the layouts is causing each page to be turned into a folder/index.html combination instead of just a web page.

fix the formatting for the repo / docs links on the rtd index page

On http://f5networks.github.io/f5-openstack-docs/releases_and_versioning/:
the bottom of the table is being cut off by the footer.

Review the VE deployment guide for accuracy and update as needed.
Should include:

• installing and configuring the lbaasv1 plugin
• using a BIG-IP VE deployed on Amazon ec2 in OpenStack

We need travis to push the generated site to gh-pages after a pull request is merged.

per @pjbreaux:

In docs/guides/includes/os_ve_deploy_vlan-provider-network.rst:

> @@ -0,0 +1,51 @@
> +.. _os_ve_deploy_vlan-provider-network:
> +
> +1. Create the data network.

The same blurb as #88 would be applied for the data network. As I understand it, it is used for client/server traffic passing through the VE.

@mattgreene knows the details of this one. In summary, travis ci should be deploying to the s3 dev environment for any build that comes from a pull request, but isn't.

• deploy the whole repo (incl config files and subfolders) to amazon s3
• navigate to http://jodietestsite.s3-website-us-west-2.amazonaws.com
• see index template file instead of site generated by jekyll build

As a workaround, I swapped out the template jekyll 'index.html' file with a generic bootstrap template (and the corresponding css & js content)
related commits:
6ccc601
86146c6

There are too many items in the nav bar and it doesn't display correctly/well when the window is too small to accommodate them all.
I need to remove the following items from the header nav bar and move them onto the home page.

• Get the plugin
• Project repos
• API libraries
• Partners

This can be done in conjunction with the transition to Read the Docs (#66).

http://f5networks.github.io/f5-openstack-docs/lbaasv1-plugin-deploy-guide/

The deploy guide is a map that uses other mini-maps to pull content together. This appears to be too much for tocify. Need to investigate whether there's a way to make tocify work this way or if we can't use mini-maps.

As the versioning strategy has changed, I need to update the versioning/support matrix accordingly.

I need to add a page that contains the version/release strategy and the support compatibility matrix.