Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 3.9 KB

README.adoc

File metadata and controls

103 lines (68 loc) · 3.9 KB
Raw

SUSE Linux Enterprise Documentation

Validate/build docs

High Availability Extension

This is the source for the official SUSE Linux Enterprise High Availability Extension documentation.

This repository hosts the documentation sources including translations (if available) for the following manuals:

  • Administration Guide

  • Geo Clustering Quick Start

  • Geo Clustering Guide

  • NFS Storage with DRBD and Pacemaker Quick Start

  • Installation and Setup Quick Start

  • Pacemaker Remote Quick Start

Released versions of the documentation are published at https://www.suse.com/documentation/sle-ha/.

Beta versions can be found at https://susedoc.github.io/#sleha, where all commits to main and maintenance branches are built automatically.

Branches

Table 1. Overview of important branches
Name Purpose

main

doc development (latest development version)

maintenance/*

maintenance for released versions

trans/*

translations for released versions

On Feb 20, 2021, we switched to a new default branch. The default branch is now called main.

Use the main branch as the basis of your commits/of new feature branches.

How to update your local repository

If you created a local clone or GitHub fork of this repo before Feb 20, 2021, do the following:

git branch -m master main
git fetch origin
git branch -u origin/main main
git pull -r

Reporting bugs

Bugs are collected on https://bugzilla.suse.com. If possible, please check for duplicates before creating a new report. When creating a new report, use SUSE Linux Enterprise High Availability Extension as the product. In the next step, select the product version where you found the bug. As the component, select Documentation.

Contributing

Thank you for contributing to this repo. When creating a pull request, please follow the guidelines below:

  1. If you want to contribute to the most recent release, create your pull request against the main branch (not develop). The main branch is is protected.

  2. If you want to contribute to a previous release, please create your pull request against the respective maintenance/* branch. These branches are also protected.

  3. Make sure all validation (GitHub Actions) checks are passed.

  4. For your pull request to be reviewed, please tag the relevant subject matter expert(s) from the development team (if applicable) and members of the documentation team: Tanja Roth (@taroth21), Thomas Schraitle (@tomschr), Tahlia Richardson (@tahliar).

  5. Implement the required changes. If you have any questions, ping a documentation team member in #team-suse-docs in Slack.

  6. For help on style and structure, refer to the Documentation Styleguide.

Editing DocBook

To contribute to the documentation, you need to write DocBook.

  • You can learn about DocBook syntax at http://docbook.org/tdg5/en/html.

  • SUSE documents are generally built with DAPS (package daps) and the SUSE XSL Stylesheets (package suse-xsl-stylesheets).

  • Install the documentation environment with the following command:

    sudo /sbin/OneClickInstallUI https://gitlab.nue.suse.com/susedoc/doc-ymp/raw/master/Documentation.ymp

  • Basic daps usage:

    • $ daps -d DC-<YOUR_BOOK> validate: Make sure what you have written is well-formed XML and valid DocBook 5

    • $ daps -d DC-<YOUR_BOOK> pdf: Build a PDF document

    • $ daps -d DC-<YOUR_BOOK> html: Build a multi-page HTML document

    • Learn more at https://opensuse.github.io/daps

License

The content of this project itself is licensed under the GFDL 1.2.