{"id":29190661,"url":"https://github.com/owncloud/docs","last_synced_at":"2025-07-02T00:10:45.879Z","repository":{"id":37789465,"uuid":"129260244","full_name":"owncloud/docs","owner":"owncloud","description":"ownCloud Documentation (v2)","archived":false,"fork":false,"pushed_at":"2025-06-10T07:27:30.000Z","size":190871,"stargazers_count":55,"open_issues_count":72,"forks_count":89,"subscribers_count":38,"default_branch":"master","last_synced_at":"2025-06-28T18:13:12.730Z","etag":null,"topics":["antora","asciidoc","documentation"],"latest_commit_sha":null,"homepage":"https://doc.owncloud.com","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/owncloud.png","metadata":{"files":{"readme":"README.md","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}},"created_at":"2018-04-12T14:01:28.000Z","updated_at":"2025-06-10T07:27:33.000Z","dependencies_parsed_at":"2023-10-16T21:36:07.684Z","dependency_job_id":"cf081f98-60cc-447c-8dc5-3200838501e6","html_url":"https://github.com/owncloud/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/owncloud/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owncloud%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owncloud%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owncloud%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owncloud%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/owncloud","download_url":"https://codeload.github.com/owncloud/docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owncloud%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263052430,"owners_count":23406106,"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","asciidoc","documentation"],"created_at":"2025-07-02T00:10:45.232Z","updated_at":"2025-07-02T00:10:45.868Z","avatar_url":"https://github.com/owncloud.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ownCloud Documentation\n\n[![Build Status](http://drone.owncloud.com/api/badges/owncloud/docs/status.svg?branch=master)](http://drone.owncloud.com/owncloud/docs)\n\n1. The platform and tools used to build the documentation is [Antora](./docs/what-is-antora.md).\n2. The file format that the documentation is written in is [AsciiDoc](./docs/what-is-asciidoc.md).\n3. The \u003cabbr title=\"User Interface\"\u003eUI\u003c/abbr\u003e \u0026 \u003cabbr title=\"User Experience\"\u003eUX\u003c/abbr\u003e of the documentation can be found at [docs-ui](https://github.com/owncloud/docs-ui)\n\n**Table of Contents**\n\n* [Antora Site Structure for Docs](#antora-site-structure-for-docs)\n* [Extensions](#extensions)\n* [Documentation Guidelines](#documentation-guidelines)\n* [Contributing to the Documentation](#contributing-to-the-documentation)\n* [Generating the Documentation](#generating-the-documentation)\n* [Common Content and Styling the Documentation](#common-content-and-styling-the-documentation)\n* [Best Practices and Tips](#best-practices-and-tips)\n* [Target Branch and Backporting](#target-branch-and-backporting)\n* [When Does a Change Get Published to the Docs Web Site?](#when-does-a-change-get-published-to-the-docs-web-site)\n* [Create a New Version Branch for Docs](#create-a-new-version-branch-for-docs)\n* [HTML to PDF](#html-to-pdf)\n\n## Antora Site Structure for Docs\n\nRefer to the [Antora Site Structure for Docs](./docs/antora-site-structure.md) for more information. \n\n## Extensions\n\nThe documentation intensively uses Antora/Asciidoc extensions. These extensions enrich the base functionality with additional and required capabilities. Read the [extensions](./docs/extensions.md) documentation for more information.\n\n## Documentation Guidelines\n\nRefer to the [Documentation Guidelines](./docs/doc-guidelines.md) for more information about backgrounds and processes.\n\n## Contributing to the Documentation\n\nTo get started contributing to the documentation, please refer to the [Getting Started Guide](./docs/getting-started.md).\n\nWith regard to language and style issues, consult the [Style Guide](./docs/style-guide.md).\n\nNote that the documentation provides a setting for the [IntelliJ AsciiDoc-Antora Plugin](https://intellij-asciidoc-plugin.ahus1.de) to preview a page using the css sourced from `doc.owncloud.com`. The file required containing the necessary configuration is `.asciidoctorconfig`.\n\n## Generating the Documentation\n\n**IMPORTANT**  \nWe use `node 18.19.0`. In case you used a lower node version for your local doc repos, you must upgrade them **all**. See the link below for details.\n\n**IMPORTANT**  \nWe use `Antora 3.1.10` and use npm instead of yarn. In case you used a lower Antora version for your local doc repos, you must upgrade them **all** by syncing them and running `npm install` in each doc repo.\n\nTo generate and view the documentation locally or planning major changes, refer to the [Building the Documentation guide](./docs/build-the-docs.md).\n\n## Common Content and Styling the Documentation\n\nIf you want to suggest an improvement to the ownCloud documentation theme, such as the layout, the header or the footer text, or if you find a bug, all the information that you need is in the `docs-ui` repository. Changes made in `docs-ui` are valid for the whole documentation.\n\nPlease read how to test un-merged [docs-ui](./docs/test-ui-bundle.md) changes with content from the ownCloud documentation.\n\n## Best Practices and Tips\n\nRefer to [Best Practices and Tips for writing in AsciiDoc](./docs/best-practices.md) for more information.\n\nTo check for broken links manually, see [install and use a broken-link-checker](./docs/checking-broken-links.md).\n\n## Target Branch and Backporting\n\nPlease always do your changes in `master` and backport them to the relevant branches.\nThe **ONLY** reason for doing a PR in a branch directly is, to fix an issue which is\n_only_ present in that particular branch! When creating a PR and it is necessary to backport,\ndocument in the PR to which branches a backport is needed.\n\nWhen backporting, consider using the [backport script](./docs/getting-started.md#backporting)\nwhich eases life a lot and speeds up the process. It is also very beneficial when using the\nextended code provided, because a clear naming structure of the backport PR is generated automatically.\n\n## When Does a Change Get Published to the Docs Web Site?\n\nChanges made will get published to the web under the following conditions:\n\n1. A merge in a component to one of the defined version branches triggers as a last step a master branch build.\n2. A merge to master triggers a site build which then pushes all versions defined in site.yml.\n\n## Create a New Version Branch for Docs\n\nPlease refer to [Create a New Version Branch for Docs](./docs/new-version-branch.md) for more information.\n\n## HTML to PDF\n\nAt the moment, creating a pdf is dropped from the build process but can be re-implemented if required.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowncloud%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fowncloud%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowncloud%2Fdocs/lists"}