https://github.com/suse/doc-sleha
Official SUSE Linux Enterprise High Availability documentation
https://github.com/suse/doc-sleha
documentation enterprise high-availability suse
Last synced: 27 days ago
JSON representation
Official SUSE Linux Enterprise High Availability documentation
- Host: GitHub
- URL: https://github.com/suse/doc-sleha
- Owner: SUSE
- License: other
- Created: 2015-06-25T06:44:49.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2025-03-26T06:15:16.000Z (about 1 month ago)
- Last Synced: 2025-03-26T18:54:36.274Z (about 1 month ago)
- Topics: documentation, enterprise, high-availability, suse
- Language: Makefile
- Homepage: https://documentation.suse.com/sle-ha/
- Size: 101 MB
- Stars: 17
- Watchers: 11
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= SUSE Linux Enterprise Documentation
image:https://github.com/SUSE/doc-sleha/actions/workflows/docbook.yml/badge.svg["Validate/build docs", link=https://susedoc.github.io/#sle-ha]
= 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
.Overview of important branches
[options="header"]
|================================================
| 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:
. 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.
. If you want to contribute to a previous release, please create your pull request against the respective `maintenance/*` branch. These branches are also protected.
. Make sure all validation (GitHub Actions) checks are passed.
. 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).
. Implement the required changes. If you have any questions, ping a documentation team member in #team-suse-docs in Slack.
. For help on style and structure, refer to the https://doc.opensuse.org/products/opensuse/Styleguide/opensuse_documentation_styleguide_sd/[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:
+
[source]
----
sudo /sbin/OneClickInstallUI https://gitlab.nue.suse.com/susedoc/doc-ymp/raw/master/Documentation.ymp
----
* Basic daps usage:
** `$ daps -d DC- validate`: Make sure what you have written is
well-formed XML and valid DocBook 5
** `$ daps -d DC- pdf`: Build a PDF document
** `$ daps -d DC- 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 https://www.gnu.org/licenses/fdl-1.2.html[GFDL 1.2].