{"id":23826154,"url":"https://github.com/appuio/openshift4-docs","last_synced_at":"2026-01-31T13:37:33.802Z","repository":{"id":37097664,"uuid":"263649549","full_name":"appuio/openshift4-docs","owner":"appuio","description":"APPUiO Managed OpenShift 4 Documentation","archived":false,"fork":false,"pushed_at":"2024-04-05T15:52:24.000Z","size":1289,"stargazers_count":2,"open_issues_count":12,"forks_count":2,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-04-06T11:44:51.398Z","etag":null,"topics":["antora","appuio","asciidoc","documentation","openshift","openshift-v4","projectsyn","syn","vshn","vshn-project-ocp"],"latest_commit_sha":null,"homepage":"https://kb.vshn.ch/oc4/","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}},"created_at":"2020-05-13T14:13:17.000Z","updated_at":"2024-04-15T13:03:06.127Z","dependencies_parsed_at":"2023-09-27T18:55:36.953Z","dependency_job_id":"50ad08c5-5286-410d-8d10-4956ae0d8911","html_url":"https://github.com/appuio/openshift4-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fopenshift4-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fopenshift4-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fopenshift4-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fopenshift4-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appuio","download_url":"https://codeload.github.com/appuio/openshift4-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240113938,"owners_count":19749829,"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":["antora","appuio","asciidoc","documentation","openshift","openshift-v4","projectsyn","syn","vshn","vshn-project-ocp"],"created_at":"2025-01-02T12:16:16.776Z","updated_at":"2026-01-31T13:37:28.752Z","avatar_url":"https://github.com/appuio.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"= APPUiO Managed OpenShift 4 Documentation\n\nThis repository contains all the content of the APPUiO Managed OpenShift 4 documentation hosted at https://kb.vshn.ch/oc4/.\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%2Fopenshift4-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappuio%2Fopenshift4-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappuio%2Fopenshift4-docs/lists"}