This repository houses the end-user documentation for F5 Networks' Container Connectors (CC). The documentation is published at http://clouddocs.f5.com/containers/latest.
We write documentation in reStructuredText (rST); build with Sphinx ; test with Travis-CI ; and publish to a static website hosted in Amazon s3.
If you want to contribute to this documentation set, please consult the F5 Open Source Style Guide and training first. Once you've completed the training and are ready to start writing, fork this repo.
- Create an issue corresponding to the changes/additions you plan to make. When your work is complete, open a pull request.
- Be sure to fetch and rebase often so your fork stays up-to-date!
The scripts directory contains documentation testing resources. We recommend running the test script before opening a pull request; if the build associated with your PR doesn't pass, the request won't be accepted.
The test script can be run locally or in a Docker container, which uses an image developed by F5 (https://hub.docker.com/r/f5devcentral/containthedocs/ ). The Ubuntu-based Docker image has all of the dependencies required to build the project documentation pre-installed. If you want to run the test script locally, you'll need to install the requirements first.
- scripts/docker-docs.sh -- runs a Docker container with the 'containthedocs' image.
- scripts/test-docs.sh -- builds the documentation (
make -C docs/ html); runsmake linkcheckto check internal and external links; and checks grammar withwrite-good. These tests run in travis-ci and must pass before we can accept a pull request.
To run the test script in the Docker container:
$ ./scripts/docker-docs.sh ./scripts/test-docs.sh
To run the script without using Docker:
$ pip install -r requirements.txt $ npm install -g write-good $ ./scripts/test-docs.sh
Individuals or business entities who contribute to this project must have completed and submitted the F5 Contributor License Agreement prior to their code submission being included in this project.
To report an issue or request additional guides, please open an Issue. Use the issue template provided and, please, be specific!
See Support.
Copyright 2015-2018 F5 Networks Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.