{"id":21634802,"url":"https://github.com/opendevstack/ods-documentation","last_synced_at":"2026-03-03T20:31:09.772Z","repository":{"id":36492399,"uuid":"188013899","full_name":"opendevstack/ods-documentation","owner":"opendevstack","description":"Antora playbooks to generate the versioned documentation","archived":false,"fork":false,"pushed_at":"2026-03-03T03:40:58.000Z","size":118546,"stargazers_count":0,"open_issues_count":11,"forks_count":6,"subscribers_count":31,"default_branch":"master","last_synced_at":"2026-03-03T07:54:09.754Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opendevstack.png","metadata":{"files":{"readme":"README.adoc","changelog":"CHANGELOG.adoc","contributing":null,"funding":null,"license":null,"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":"2019-05-22T10:12:35.000Z","updated_at":"2026-03-03T03:41:01.000Z","dependencies_parsed_at":"2023-10-15T03:13:19.338Z","dependency_job_id":"bacbf372-fc71-4c77-a280-81ece21f3bca","html_url":"https://github.com/opendevstack/ods-documentation","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/opendevstack/ods-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opendevstack%2Fods-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opendevstack%2Fods-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opendevstack%2Fods-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opendevstack%2Fods-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opendevstack","download_url":"https://codeload.github.com/opendevstack/ods-documentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opendevstack%2Fods-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30058263,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T18:21:05.932Z","status":"ssl_error","status_checked_at":"2026-03-03T18:20:59.341Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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-11-25T03:18:12.515Z","updated_at":"2026-03-03T20:31:09.742Z","avatar_url":"https://github.com/opendevstack.png","language":"CSS","readme":"# The ODS Antora Playbook Repository\n\n## Building documentation locally\n\n### Prerequisites\n\n- Antora (3.1) has to be installed according to the https://docs.antora.org/antora/3.1/install/install-antora/[Install Antora] guide.\n- The following OpenDevStack repositories have to be cloned and stored beside the `ods-documentation` repository: `ods-core`, `ods-jenkins-shared-library`, `ods-provisioning-app` and `ods-quickstarters`.\n\n### Generate docs using `site-workspace.yml`\n\nTo preview your local changes, just building documentation from `HEAD`.\n\n   antora generate site-workspace.yml\n\nThe output will be written to `docs_local`, which is ignored by git. This directory is only for local preview and verification.\n\n### Generate docs using `site-workspace-full.yml`\n\nTo preview your local changes, taking into account all branches.\n\n   antora generate site-workspace-full.yml\n\nThe output will be written to `docs_local`, which is ignored by git. This directory is only for local preview and verification.\n\nNote that for this playbook, you will also need the following repositories locally:\n\n- `opendevstack.github.io`\n- `ods-project-quickstarters`\n\n### Customize the UI\n\nBy default, the playbooks reference a UI bundle from https://github.com/opendevstack/ods-docs-ui/releases. You can also clone that repo locally, customize the UI, build a new UI bundle and reference that when running `antora`.\n\nTo build a UI bundle, read the documentation at\nhttps://github.com/opendevstack/ods-docs-ui/blob/ods-docs-ui/README.adoc. Example:\n\n    cd ../ods-docs-ui\n    # Compile\n    npm install\n    # Create file ui-bundle.zip\n    gulp bundle\n    # Reference it\n    cd ../ods-documentation\n    antora generate site-workspace.yml --ui-bundle-url ../ods-docs-ui/build/ui-bundle.zip\n\n### Search Function\n\nA search index is created by the antora lunr extension.\n\n## Building using GitHub Actions\n\nWhenever this repository is pushed to GitHub, it triggers a build using GitHub Actions,\nthat regenerates the antora documentation based on the `site.yml` playbook (which fetches the different referenced repositories from GitHub). The\nupdated content in directory `docs` will be pushed back to the GitHub repository during the build. The build environment uses the GitHub Token (env: GITHUB_TOKEN) with write privileges to the repository.\n\nSee xref:.github/workflows/renderDocs.yml[.github/workflows/renderDocs.yml] for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopendevstack%2Fods-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopendevstack%2Fods-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopendevstack%2Fods-documentation/lists"}