An open API service indexing awesome lists of open source software.

https://github.com/owncloud/docs-main


https://github.com/owncloud/docs-main

Last synced: 12 months ago
JSON representation

Awesome Lists containing this project

README

          

# ownCloud Main Page

**Table of Contents**

* [Building the Main Page Docs](#building-the-main-page-docs)
* [General Notes](#general-notes)
* [Generating the Documentation](#generating-the-documentation)
* [Target Branch and Backporting](#target-branch-and-backporting)
* [Branching Workflow](#branching-workflow)
* [Create a New Version Branch for the docs Main Page](#create-a-new-version-branch-for-the-docs-main-page)

## Building the Main Page Docs

The ownCloud Main Page documentation is not built independently. Instead, it is built together with the [documentation](https://github.com/owncloud/docs/). However, you can build a local copy of the ownCloud Server documentation to preview changes you are making.

Whenever a Pull Request of this repo gets merged, it automatically triggers a full docs build.

## General Notes

To make life easier, most of the content written in [docs](https://github.com/owncloud/docs#readme) applies also here. For ease of reading, the most important steps are documented here too. For more information see the link provided. Only a few topics of this repo are unique like the branching.

## Generating the Documentation

See the [Generating the Documentation](https://github.com/owncloud/docs#generating-the-documentation) in the docs repo for more details as it applies to all documentation repositories.

## Target Branch and Backporting

See the [following section](https://github.com/owncloud/docs#target-branch-and-backporting) as the same rules and notes apply.

## Branching Workflow

Please refer to the [Branching Workflow for the docs main page](./docs/the-branching-workflow.md) for more information.

## Create a New Version Branch for the Docs Main Page

Please refer to [Create a New Version Branch for the docs main page](./docs/new-version-branch.md) for more information.