{"id":13816159,"url":"https://github.com/openstack/operations-guide","last_synced_at":"2026-01-28T04:48:45.906Z","repository":{"id":8643749,"uuid":"10293242","full_name":"openstack/operations-guide","owner":"openstack","description":"OpenStack Operations Guide. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2026-01-21T17:52:17.000Z","size":32687,"stargazers_count":69,"open_issues_count":0,"forks_count":14,"subscribers_count":10,"default_branch":"master","last_synced_at":"2026-01-22T17:50:45.570Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/operations-guide","language":null,"has_issues":false,"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/openstack.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":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2013-05-26T03:51:39.000Z","updated_at":"2026-01-21T17:53:14.000Z","dependencies_parsed_at":"2024-04-03T17:28:27.846Z","dependency_job_id":"3f600ace-b77b-4709-be00-fd521e46ef08","html_url":"https://github.com/openstack/operations-guide","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/openstack/operations-guide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Foperations-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Foperations-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Foperations-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Foperations-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/operations-guide/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Foperations-guide/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28838813,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T02:10:51.810Z","status":"ssl_error","status_checked_at":"2026-01-28T02:10:50.806Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-08-04T05:00:36.331Z","updated_at":"2026-01-28T04:48:45.901Z","avatar_url":"https://github.com/openstack.png","language":null,"readme":"==========================\nOpenStack Operations Guide\n==========================\n\nThis repository contains the source files for the OpenStack Operations Guide.\n\nYou can read this guide at `docs.openstack.org/operations-guide\n\u003chttps://docs.openstack.org/operations-guide\u003e`_.\n\nPrerequisites\n-------------\n\nAt a minimum, you will need git and the git-review tool installed in order to\ncontribute documentation. You will also need a `Gerrit account\n\u003chttps://docs.openstack.org/infra/manual/developers.html#account-setup\u003e`_ to\nsubmit the change.\n\nGit is available for Linux, Mac, and Windows environements. Some platforms come\nwith it preinstalled, but you can review the `installation instructions\n\u003chttps://git-scm.com/book/en/v2/Getting-Started-Installing-Git\u003e`_ if you\ndo not have it by default.\n\nOnce git is installed, you can follow the instructions for your platform to\n`install git-review \u003chttps://docs.opendev.org/opendev/git-review/latest/installation.html\u003e`_.\n\nThe last step is to configure git with your name and email address used for\nyour Gerrit account set up so it can link you patch to your user. Run the\nfollowing to set these values:\n\n.. code-block:: console\n\n  git config --global user.name \"First Last\"\n  git config --global user.email \"your_email@youremail.com\"\n\n\nSubmitting Updates\n------------------\n\nProposing updates to the documentation is fairly straight forward once you've\ndone it, but there are a few steps that can appear intimidating your first\ncouple times through. Here is a suggested workflow to help you along the way.\n\n.. code-block:: console\n\n  git clone https://opendev.org/openstack/operations-guide\n  cd operations-guide\n\n  # it is useful to make changes on a separate branch in case you need to make\n  # other changes\n  git checkout -b my-topic\n\n  # edit your files\n  git add .\n  git commit # Add a descriptive commit message\n\n  # submit your changes for review\n  git review\n\nThe changes will then be run through a few tests to make sure the docs build\nand it will be ready for reviews. Once reviewed, if no problems are found with\nthe changes they will be merged to the repo and the changes will be published\nto the docs.openstack.org site.\n\nLocal Testing\n-------------\n\nIf you would like to build the docs locally to make sure there are no issues\nwith the changes, and to view locally generated HTML files, you will need to do\na couple extra steps.\n\nThe jobs are run using a tool called `tox`. You will need to install tox on\nyour platform first following its `installation guide\n\u003chttps://tox.wiki/en/latest/installation.html\u003e`_.\n\nYou can then run the following to perform a local build with some tests:\n\n.. code-block:: console\n\n  tox -e docs\n\nIf you have any questions, please reach out on the #openstack-operators IRC\nchannel or through the openstack-ops mailing list.\n","funding_links":[],"categories":["Others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Foperations-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Foperations-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Foperations-guide/lists"}