{"id":13646765,"url":"https://github.com/openstack/openstack-manuals","last_synced_at":"2025-10-10T20:38:50.506Z","repository":{"id":1668889,"uuid":"2395672","full_name":"openstack/openstack-manuals","owner":"openstack","description":"OpenStack Manuals. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2025-10-01T13:49:24.000Z","size":765213,"stargazers_count":422,"open_issues_count":0,"forks_count":252,"subscribers_count":78,"default_branch":"master","last_synced_at":"2025-10-01T14:18:08.640Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/openstack-manuals","language":"HTML","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":"CONTRIBUTING.rst","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":"2011-09-15T22:02:39.000Z","updated_at":"2025-10-01T13:49:28.000Z","dependencies_parsed_at":"2023-07-05T19:48:49.759Z","dependency_job_id":"dbc1e671-092d-4b90-9e70-127c41818cab","html_url":"https://github.com/openstack/openstack-manuals","commit_stats":{"total_commits":11965,"total_committers":1190,"mean_commits":"10.054621848739496","dds":0.9118261596322608,"last_synced_commit":"704fde262662ca8a7b61639118f452fb3dbe6757"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/openstack/openstack-manuals","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fopenstack-manuals","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fopenstack-manuals/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fopenstack-manuals/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fopenstack-manuals/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/openstack-manuals/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fopenstack-manuals/sbom","scorecard":{"id":113977,"data":{"date":"2025-08-04","repo":{"name":"github.com/openstack/openstack-manuals","commit":"8495ea30a6893998aab1cb22b8d3d8463a89444b"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"21 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"Vulnerabilities","score":0,"reason":"13 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2019-217 / GHSA-462w-v97r-4m45","Warn: Project is vulnerable to: GHSA-cpwx-vrp4-4pq7","Warn: Project is vulnerable to: PYSEC-2021-66 / GHSA-g3rq-g295-4j3m","Warn: Project is vulnerable to: GHSA-h5c8-rqwp-cp95","Warn: Project is vulnerable to: GHSA-h75v-3vvj-5mfj","Warn: Project is vulnerable to: PYSEC-2019-220 / GHSA-hj2j-77xm-mc5v","Warn: Project is vulnerable to: GHSA-q2x7-8rv6-6q7h","Warn: Project is vulnerable to: PYSEC-2021-142 / GHSA-8q59-q68h-6hv4","Warn: Project is vulnerable to: PYSEC-2018-49 / GHSA-rprw-h62v-c2w7","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q","Warn: Project is vulnerable to: PYSEC-2018-28 / GHSA-x84v-xcm2-53pg"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}}]},"last_synced_at":"2025-08-15T21:50:25.362Z","repository_id":1668889,"created_at":"2025-08-15T21:50:25.362Z","updated_at":"2025-08-15T21:50:25.362Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005272,"owners_count":26083863,"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","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-02T01:03:05.306Z","updated_at":"2025-10-10T20:38:50.491Z","avatar_url":"https://github.com/openstack.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"=================\nOpenStack Manuals\n=================\n\nThis repository contains documentation for the OpenStack project.\n\nFor more details, see the `OpenStack Documentation Contributor\nGuide \u003chttps://docs.openstack.org/doc-contrib-guide/\u003e`_.\n\nIt includes these manuals:\n\n* API Guide (Quick Start)\n* Documentation Contributor Guide\n* Installation Guide\n* Virtual Machine Image Guide\n\nIn addition to the guides, this repository contains:\n\n* docs.openstack.org contents: ``www``\n\nBuilding\n========\n\nVarious manuals are in subdirectories of the ``doc/`` directory.\n\nGuides\n------\n\nSome pre-requisites are needed to build the guides. If you are using a Linux\noperating system you can generate a report of missing local requirements with\nthe ``bindep`` command::\n\n    $ tox -e bindep\n\nAll guides are in the RST format. You can use ``tox`` to prepare\nvirtual environment and build all guides (HTML only)::\n\n    $ tox -e docs\n\nYou can also build a specific guide.\n\nFor example, to build *OpenStack Virtual Machine Image Guide*, use the\nfollowing command::\n\n    $ tox -e build -- image-guide\n\nYou can find the root of the generated HTML documentation at::\n\n    doc/image-guide/build/html/index.html\n\nTo build a specific guide with a PDF file, add a ``-pdf`` option like::\n\n    $ tox -e build -- image-guide --pdf\n\nThe generated PDF file will be copied to the root directory of the\ngenerated HTML documentation.\n\nPDF builds are accomplished using LaTeX as an intermediate format. Currently,\nyou can generate a PDF file for a limited number of guides. The supported list\nis maintained in the ``tools/build-all-rst.sh`` file.\n\nIf you get the error message ``make: xelatex: No such file or directory``, it\nmeans your local environment does not have LaTeX installed. Read\n`Getting LaTeX \u003chttps://www.latex-project.org/get/\u003e`_ and\n`Install dependencies for building documentation\n\u003chttps://docs.openstack.org/doc-contrib-guide/docs-builds.html#install-dependencies-for-building-documentation\u003e`_\nfor instructions.\n\nTesting of changes and building of all manuals\n==============================================\n\nInstall the Python tox package and run ``tox`` from the top-level\ndirectory to use the same tests that are done as part of the OpenStack\nCI jobs.\n\nIf you like to run individual tests, run:\n\n* ``tox -e publishdocs`` - to actually build the manual; this also generates a\n  directory ``publish-docs`` that contains the built files for inspection\n* ``tox -e publishlang`` - to build translated manuals\n* ``tox -e linters`` - to run the niceness tests, for example, to see extra\n  whitespaces\n* ``tox -e linkcheck`` - to run the tests for working remote URLs\n\nThe ``tox`` command uses the openstack-doc-tools package to run the\ntests.\n\n\nGenerated files\n---------------\n\nSome documentation files are generated using tools. These files include\na ``do not edit`` header and should not be modified by hand.\nPlease see `Generated files\n\u003chttps://docs.openstack.org/doc-contrib-guide/doc-tools.html\u003e`_.\n\n\nBugs\n====\n\nBugs should be filed on Launchpad, not GitHub:\n\nhttps://bugs.launchpad.net/openstack-manuals\n\n\nRelease Notes\n=============\n\nhttps://docs.openstack.org/releasenotes/openstack-manuals\n\n\nInstalling\n==========\n\nRefer to https://docs.openstack.org to see where these documents are\npublished and to learn more about the OpenStack project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fopenstack-manuals","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Fopenstack-manuals","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fopenstack-manuals/lists"}