{"id":22914285,"url":"https://github.com/suse/doc-caasp","last_synced_at":"2025-03-06T00:12:24.288Z","repository":{"id":54360915,"uuid":"83820004","full_name":"SUSE/doc-caasp","owner":"SUSE","description":"SUSE Container as a Service Platform Documentation","archived":false,"fork":false,"pushed_at":"2024-09-03T22:17:37.000Z","size":22339,"stargazers_count":27,"open_issues_count":10,"forks_count":55,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-02-26T23:11:16.652Z","etag":null,"topics":["container","documentation","enterprise","suse"],"latest_commit_sha":null,"homepage":"https://documentation.suse.com/suse-caasp/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SUSE.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}},"created_at":"2017-03-03T16:44:30.000Z","updated_at":"2021-12-31T06:37:53.000Z","dependencies_parsed_at":"2025-01-07T02:32:03.307Z","dependency_job_id":null,"html_url":"https://github.com/SUSE/doc-caasp","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fdoc-caasp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fdoc-caasp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fdoc-caasp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fdoc-caasp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SUSE","download_url":"https://codeload.github.com/SUSE/doc-caasp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242123250,"owners_count":20075344,"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":["container","documentation","enterprise","suse"],"created_at":"2024-12-14T05:14:14.502Z","updated_at":"2025-03-06T00:12:24.259Z","avatar_url":"https://github.com/SUSE.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"= SUSE CaaS Platform Documentation\n:revdate: 2019-05-24\n\nimage:https://travis-ci.org/SUSE/doc-caasp.svg?branch=adoc[\"Build Status\", link=\"https://travis-ci.org/SUSE/doc-caasp\"]\n\nThis is the source for the official SUSE CaaS Platform documentation\n\nReleased versions of the documentation will be published at\nhttps://documentation.suse.com/ once available.\n\n== Contributing\n\n.Allow maintainer updates for pull requests\n[IMPORTANT]\nWhen creating a Pull Request please allow maintainers to push commits into your fork.\nSee: https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork\n\nIf you would like to contribute, please fork this repository and send pull requests.\n\nFor help on style and structure, refer to the https://doc.opensuse.org/products/opensuse/Styleguide/opensuse_documentation_styleguide_sd/[Documentation Styleguide]\n\n== Branches\n\n[IMPORTANT]\nChanges to already released versions of the documentation must be merged to a `maintenance/CaaSX` branch from the maintainer.\n\nWe maintain three versions of the product at this point:\n\n* master (ongoing 4.5.x work)\n* maintenance/CaaS4.5 (4.5.x released version and incremental updates)\n* maintenance/CaaS4 (4.2.x released version and incremental updates)\n\n== Files and Directory Structure\n\n* `DC-caasp-*`: Configuration files for the exported guides.\n* `adoc/`: Contains all the pages that make up the content.\n* `adoc/book_*`: Meta files collating pages into a guide document.\n* `adoc/attributes.adoc` - Contains all version numbers of the product and its components.\nAlso contains the `release_type` flag that determines if the branch contains an `public` or (SUSE) `internal` release.\n* `adoc/entities.adoc` - Contains text substitutions for often used component names and strings.\n* `adoc/common_*`: Include files with common information like legal disclaimers and licenses.\n* `adoc/admin-*`: Pages belonging to the Admin guide.\n* `adoc/deployment-*`: Pages belonging to the Deployment guide.\n* `adoc/architecture-*`: Pages belonging to the Architecture guide.\n* `adoc/quick-*`: Pages belonging to the Quickstart guide.\n\n== Editing AsciiDoc\n\nTo contribute to the documentation you will use AsciiDoc syntax.\n\n* You can learn about AsciiDoc syntax at link:https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[]\n** A much more detailed manual can be found link:https://asciidoctor.org/docs/user-manual/[here]\n* For simple preview use the browser extensions for\n** https://chrome.google.com/webstore/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia[Chrome]\n** https://addons.mozilla.org/en-US/firefox/addon/asciidoctorjs-live-preview/[Firefox]\n** Make sure you set the \"security\" setting in the Extension Preferences to `server`\n\n* SUSE documents are generally built with DAPS (package `daps`) and the\n  SUSE XSL Stylesheets (package `suse-xsl-stylesheets`). It's available as a\n  SUSE rpm package from the the SUSE repository http://download.opensuse.org/repositories/Documentation:/Tools/[Documentation:Tools] or\n  directly from https://github.com/openSUSE/suse-xsl/[Github].\n* If you are running a (recent) version of openSUSE, you can install our documentation toolchain with the following command:\n`sudo /sbin/OneClickInstallUI https://gitlab.nue.suse.com/susedoc/doc-ymp/raw/master/Documentation.ymp`\n* If you don't want to download the entire documentation toolchain, you can also build documentation using DAPS inside a Docker container with https://github.com/openSUSE/daps2docker[daps2docker]:\n** Clone the daps2docker repository.\n** Change directory to the folder which contains your documentation source files (`doc-caasp`).\n** Execute the `daps2docker.sh` file, for example by running `../daps2docker/daps2docker.sh .`.\n** Follow the commandline instructions for further building options.\n* Basic daps usage:\n** `$ daps -d DC-\u003cYOUR_BOOK\u003e validate`: Make sure what you have written is\n    well-formed XML and valid DocBook 5\n** `$ daps -d DC-\u003cYOUR_BOOK\u003e pdf`: Build a PDF document\n** `$ daps -d DC-\u003cYOUR_BOOK\u003e html`: Build multi-page HTML document\n** Learn more at https://opensuse.github.io/daps\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuse%2Fdoc-caasp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuse%2Fdoc-caasp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuse%2Fdoc-caasp/lists"}