{"id":23826111,"url":"https://github.com/appuio/managed-openshift-docs","last_synced_at":"2026-02-26T21:01:22.901Z","repository":{"id":70136752,"uuid":"603047638","full_name":"appuio/managed-openshift-docs","owner":"appuio","description":"APPUiO Managed OpenShift End-User Documentation","archived":false,"fork":false,"pushed_at":"2025-10-27T12:29:44.000Z","size":1075,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-10-27T14:29:37.149Z","etag":null,"topics":["appuio","documentation","openshift","openshift-v4","vshn-project-ocp"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appuio.png","metadata":{"files":{"readme":"README.adoc","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":"2023-02-17T14:07:41.000Z","updated_at":"2025-03-19T12:45:44.000Z","dependencies_parsed_at":"2024-08-12T10:06:41.534Z","dependency_job_id":"f3a7581d-6bf8-492b-bf8e-7d4da3ea6ec0","html_url":"https://github.com/appuio/managed-openshift-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/appuio/managed-openshift-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fmanaged-openshift-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fmanaged-openshift-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fmanaged-openshift-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fmanaged-openshift-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appuio","download_url":"https://codeload.github.com/appuio/managed-openshift-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fmanaged-openshift-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29872669,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-26T18:42:30.764Z","status":"ssl_error","status_checked_at":"2026-02-26T18:41:47.936Z","response_time":89,"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":["appuio","documentation","openshift","openshift-v4","vshn-project-ocp"],"created_at":"2025-01-02T12:15:47.663Z","updated_at":"2026-02-26T21:01:22.866Z","avatar_url":"https://github.com/appuio.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"= APPUiO Managed OpenShift :: Documentation for End-Users\n\nThis repository contains all the content hosted at https://docs.appuio.ch/managed-openshift\n\nThe content is written in https://asciidoctor.org/docs/what-is-asciidoc/[AsciiDoc] and rendered using https://docs.antora.org/[Antora].\n\n[TIP]\n====\n* Writing AsciiDoc is best done using Visual Studio Code with https://marketplace.visualstudio.com/items?itemName=asciidoctor.asciidoctor-vscode[the AsciiDoc addon].\n* For a reference what you can do with AsciiDoc, have a look at https://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc Writer’s Guide].\n* Antora is capable of doing many great things with documentation. See https://docs.antora.org/[the Antora docs] to gain insights into the tooling.\n====\n\n== Documentation structure\n\nThe documentation structure is inspired by the https://documentation.divio.com/[Divio's documentation structure]:\n\nTutorials (Learning-oriented):: A lesson which teaches you something.\nLocation: `docs/modules/ROOT/pages/tutorials`.\n\nHow-to guides (Problem-oriented):: Step-by-step guides to achieve a goal. Location: `docs/modules/ROOT/pages/how-tos`.\n\nTechnical reference (Information-oriented):: Description about the inner ongoings. Location: `docs/modules/ROOT/pages/tutorials`.\n\nExplanation (Understanding-oriented):: Explains the background. Location: `docs/modules/ROOT/pages/explanations`.\n\n== Contributing\n\nCreate a new branch to make the changes. After you're satisfied with the changes open a Pull Request against the `master` branch.\n\n=== Previewing Changes\n\nTo preview your changes locally, make sure you have Docker or Podman installed.\n\nJust type `make preview` and open your browser at http://localhost:2020. This even provides support for live reload when working on the content. See https://github.com/vshn/antora-preview#livereload[this documentation] for more information about it.\n\n=== Adding a New Page\n\n. Create new AsciiDoc (`.adoc`) file in the best matching folder according to the described structure under `docs/modules/ROOT/pages/`.\n. Add the file to the navigation under `docs/modules/ROOT/partials/`\n\nFor removing pages just do the opposite: Remove the file and remove the entry in the navigation.\n\n== Deployment\n\nThis repository only holds https://docs.antora.org/antora/2.3/standard-directories/[Antora content], no plumbing and tooling (aka the Antora https://docs.antora.org/antora/2.3/run-antora/[`playbook.yml`] and `Dockerfile`) to build and deploy it.\nAll pushes to the `master` branch trigger a GitHub action (`.github/worflows/triggerci.yml`) which in turn triggers the https://git.vshn.net/vshn/docs/kb/-/blob/master/.gitlab-ci.yml[GitLab CI job] to build and deploy the content using Antora.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappuio%2Fmanaged-openshift-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappuio%2Fmanaged-openshift-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappuio%2Fmanaged-openshift-docs/lists"}