/doc-slesforsap

Official SUSE Linux Enterprise Server for SAP Applica­tions Documentation

Primary LanguageXSLT

SUSE Linux Enterprise Server for SAP Applications Documentation

This is the source for the official SUSE Linux Enterprise Server for SAP Applications documentation.

This repository hosts the documentation sources including translations (if available).

Released versions of the documentation are published at https://documentation.suse.com/sles-sap/.

Branches

On Jul 19, 2019, we changed to a new branching model. This entailed having to force push the master branch.

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

  • The develop branch has been deleted on the server. Do not to push to the develop branch. Your changes may go lost in the medium term and never make it to the proper branch.

  • If you created a local clone or GitHub fork of this repo before June 21, 2019, do the following:

    1. Make sure that your master and develop branches do not contain any important changes. If there are on either branch, export them using git format-patch or put them on a different branch.

    2. Update the repo: git fetch (To also delete references to branches that do not exist anymore on the server, you can use git fetch -p.)

    3. Go to the master branch: git checkout master

    4. Hard-reset the state of the master branch to the state on GitHub: git reset --hard origin/master

    5. Delete your local develop branch: git branch -D develop

Table 1. Overview of important branches
Name Purpose

master

Current working branch

maintenance/15_SP2

Maintenance branch for SLES-SAP 15 SP2

maintenance/15_SP1

Maintenance branch for SLES-SAP 15 SP1

maintenance/15_GA

Maintenance branch for SLES-SAP 15 GA

maintenance/12_SP4

Maintenance branch for SLES-SAP 12 SP4

maintenance/12_SP3

Maintenance branch for SLES-SAP 12 SP3

maintenance/12_SP2

Maintenance branch for SLES-SAP 12 SP2

maintenance/12_SP1

Maintenance branch for SLES-SAP 12 SP1

maintenance/12_GA

Maintenance branch for SLES-SAP 12 GA

maintenance/11_SP4

Maintenance branch for SLES-SAP 11 SP4

Contributing

Thank you for contributing to this repo. Please adhere to the following guidelines when creating a pull request:

  1. Make your pull request against the master branch (not develop) if you are contributing to the most recent release (currently SLES-SAP 15 SP1). This branch is is protected.

  2. If you are contributing to a previous release, please see maintenance/<RELEASENUMBER>_. These branches are also protected.

  3. Make sure all validation (Travis CI) checks are passed, and tag relevant SMEs from the development team (if applicable) and members of the SLES-SAP doc team: Thomas Schraitle (@tomschr), Stefan Knorr (@sknorr).

    **NOTE:** If your pull request has multiple files and reorganisation changes, please build locally using DAPS or daps2docker
(see instructions below) to verify and build the files. Travis CI only validates, and does not ensure the XML builds
are correct.

  4. Implement any required changes, or fix any merge conflicts if relevant. If you have any questions, ping a documentation team member in #susedoc on RocketChat.

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). Ideally, you should get these from the repository Documentation:Tools. However, slightly older versions are also available from the SLE and openSUSE repositories.

Building Documentation

If you are interested in building DAPS documentation (defaulting to HTML and PDF), you can utilize either DAPS directly or use daps2docker. Both tools only work on Linux.

  • Use daps2docker if you use any Linux distribution that includes Docker and Systemd and only want to build HTML, PDF, or EPUB and want to be set up as quickly as possible.

  • Use DAPS directly if you are using a recent version of openSUSE, and want to use any of the advanced features of DAPS, such as building Mobipocket or spell-checking documents.

Using daps2docker

  1. Install Docker

  2. Clone the daps2docker repository from https://github.com/openSUSE/daps2docker.

  3. Within the cloned repository, run ./daps2docker.sh /PATH/TO/DOC-DIR This builds HTML and PDF documents.

Using DAPS Directly

  • $ 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 muliti-page HTML document

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