{"id":18798795,"url":"https://github.com/f5networks/f5-ci-docs","last_synced_at":"2025-04-13T17:22:26.338Z","repository":{"id":82806232,"uuid":"65329436","full_name":"F5Networks/f5-ci-docs","owner":"F5Networks","description":"Documentation for F5's Container Ingress Services","archived":false,"fork":false,"pushed_at":"2022-11-07T17:23:19.000Z","size":7597,"stargazers_count":7,"open_issues_count":21,"forks_count":27,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-03-27T08:11:25.963Z","etag":null,"topics":["big-ip","bigip-controller","containers","docs","documentation","f5","f5networks","kubernetes","openshift"],"latest_commit_sha":null,"homepage":"http://clouddocs.f5.com/containers/v2","language":"Batchfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/F5Networks.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"SUPPORT","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-08-09T21:25:25.000Z","updated_at":"2021-03-08T19:05:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"f2b37b6f-6c1e-4d73-9c2e-2965d21ba901","html_url":"https://github.com/F5Networks/f5-ci-docs","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-ci-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-ci-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-ci-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-ci-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/F5Networks","download_url":"https://codeload.github.com/F5Networks/f5-ci-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248750867,"owners_count":21155797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["big-ip","bigip-controller","containers","docs","documentation","f5","f5networks","kubernetes","openshift"],"created_at":"2024-11-07T22:13:00.746Z","updated_at":"2025-04-13T17:22:26.329Z","avatar_url":"https://github.com/F5Networks.png","language":"Batchfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"f5-ci-docs\n==========\n\n.. image:: https://travis-ci.com/F5Networks/f5-ci-docs.svg?branch=master\n    :target: https://travis-ci.com/F5Networks/f5-ci-docs\n\nOverview\n--------\n\nThis repository houses the end-user documentation for F5's Container Ingress Services (CIS). The documentation is published at https://clouddocs.f5.com/containers/latest.\n\nWe write documentation in `reStructuredText \u003chttp://docutils.sourceforge.net/rst.html\u003e`_ (rST); build with `Sphinx \u003chttp://www.sphinx-doc.org/\u003e`_ ; test with `Travis-CI \u003chttps://travis-ci.org/\u003e`_ ; and publish to a static website hosted in `Amazon s3 \u003chttps://aws.amazon.com/s3/\u003e`_.\n\nContributing\n------------\n\nIf you want to contribute to this documentation set, please consult the `F5 Open Source Style Guide \u003ctbd\u003e`_ and `training \u003ctbd\u003e`_ first. Once you've completed the training and are ready to start writing, fork this repo.\n\n* Create an `issue \u003chttps://github.com/F5Networks/f5-ci-docs/issues\u003e`_ corresponding to the changes/additions you plan to make. When your work is complete, `open a pull request \u003chttps://github.com/F5Networks/f5-ci-docs/pulls\u003e`_.\n* Be sure to fetch and rebase often so your fork stays up-to-date!\n\nHow to Build, Test, and Deploy Documentation\n````````````````````````````````````````````\n\nThis project uses CI/CD to build, test, and deploy documentation.\n\n**Tools:**\n\n- `sphinx`: builds HTML, checks syntax, and tests links.\n- `f5-sphinx-theme \u003chttps://github.com/f5devcentral/f5-sphinx-theme\u003e`_: F5 theme for sphinx projects.\n- `write-good`: tests grammar.\n- Travis-CI: builds, tests, and deploys documentation.\n- AWS S3/CloudFront: website hosting.\n- Docker image: `f5devcentral/containthedocs \u003chttps://hub.docker.com/r/f5devcentral/containthedocs/\u003e`_\n\n**Scripts:**\n\nThe `scripts \u003c/scripts\u003e`_ 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.\n\nThe test script can be run locally or in a Docker container, which uses the F5 ``containthedocs`` image. 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 \u003crequirements.txt\u003e`_ first.\n\n- *docker-docs*: Runs a Docker container mounted to your working directory.\n- *test-docs*: Runs the HTML build, grammar check, and linkcheck.\n\nBuilding and Testing\n~~~~~~~~~~~~~~~~~~~~\n\nYou can use the commands below to build and test your work.\nCommands beginning with `docker` run in a Docker container using the same image used in Travis-CI (`f5devcentral/containthedocs \u003chttps://hub.docker.com/r/f5devcentral/containthedocs/\u003e`_).\n\nYou can view the documentation in a web browser on your local machine.\n\n+------------------------+--------------------------------------------------------+----------------------------------+\n| Command                | Description                                            | How to view docs                 |\n+========================+========================================================+==================================+\n| `make html`            | basic HTML build                                       | open docs/_build/html/index.html |\n+------------------------+--------------------------------------------------------+----------------------------------+\n| `make preview`         | builds docs as you write; view changes live in browser | open http://0.0.0.0:8000         |\n+------------------------+--------------------------------------------------------+----------------------------------+\n| `make test`            | run the docs quality tests                             | open docs/_build/html/index.html |\n+------------------------+--------------------------------------------------------+----------------------------------+\n| `make docker-html`     | Runs the docker-docs script with ``make HTML``;        | open docs/_build/html/index.html |\n|                        | uses the same container image as production builds     |                                  |\n+------------------------+--------------------------------------------------------+----------------------------------+\n| `make docker-preview`  | Runs the docker-docs script with ``make preview``;     | open http://0.0.0.0:8000         |\n|                        | uses the same container image as production builds     |                                  |\n+------------------------+--------------------------------------------------------+----------------------------------+\n| `make docker-test`     | Runs the docker-docs script with ``make test``;        | open docs/_build/html/index.html |\n|                        | uses the same container image as production builds     |                                  |\n+------------------------+--------------------------------------------------------+----------------------------------+\n\n.. note:: If you don't use the Docker container, you need to install the project dependencies locally. You can find instructions for installing/using virtualenv and pip `here \u003chttps://packaging.python.org/guides/installing-using-pip-and-virtualenv\u003e`_.\n\n::\n\n   virtualenv \u003cmy-venv\u003e\n   pip install -r requirements.txt\n   npm install write-good\n\nTips and Tricks\n```````````````\n\nSee the `F5 Open Source Documentation style guide \u003chttps://s3-us-west-2.amazonaws.com/staging-c2ub89n2qjgt1/docs-training/style_guide/index.html\u003e`_ for rST and sphinx cheat sheets, as well as general guidelines for writers.\n\nContributor License Agreement\n`````````````````````````````\n\nIndividuals or business entities who contribute to this project must have completed and submitted the `F5 Contributor License Agreement \u003c/_static/F5-contributor-license-agreement.pdf\u003e`_ prior to their code submission being included in this project.\n\nIssues\n------\n\nTo report an issue or request additional guides, please open an `Issue \u003chttps://github.com/F5Networks/f5-ci-docs/issues\u003e`_. Use the issue template provided and, please, be specific!\n\nSupport\n-------\n\nSee `Support \u003cSUPPORT\u003e`_.\n\n\nCopyright and License\n---------------------\n\nCopyright 2015-2018 F5 Networks Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff5networks%2Ff5-ci-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ff5networks%2Ff5-ci-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff5networks%2Ff5-ci-docs/lists"}