https://github.com/suse/doc-slesforsap
Official SUSE Linux Enterprise Server for SAP Applications Documentation
https://github.com/suse/doc-slesforsap
documentation enterprise sap suse
Last synced: 27 days ago
JSON representation
Official SUSE Linux Enterprise Server for SAP Applications Documentation
- Host: GitHub
- URL: https://github.com/suse/doc-slesforsap
- Owner: SUSE
- Created: 2015-12-17T15:22:07.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T08:00:49.000Z (about 1 month ago)
- Last Synced: 2025-03-25T09:21:37.614Z (about 1 month ago)
- Topics: documentation, enterprise, sap, suse
- Language: XSLT
- Homepage: https://documentation.suse.com/sles-sap/
- Size: 23.4 MB
- Stars: 11
- Watchers: 14
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
= 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
.Overview of important branches
[options="header"]
|=======================================================================
| Name | Purpose
| `main` | Current working branch
| `maintenance/15_SP4` | Maintenance branch for SLES-SAP 15 SP4
| `maintenance/15_SP3` | Maintenance branch for SLES-SAP 15 SP3
| `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_SP5` | Maintenance branch for SLES-SAP 12 SP5
| `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
|=======================================================================
***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*:
[code]
====
git branch -m master main
git fetch origin
git branch -u origin/main main
git pull -r
====
== Contributing
Thank you for contributing to this repo. Please adhere to the following guidelines when creating a pull request:
. Make your pull request against the __main__ branch if you are contributing to the most recent release. This branch is is protected.
. If you are contributing to a previous release, please see _maintenance/__. These branches are also protected.
. 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).
**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.
. 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- 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 multi-page HTML document
** Learn more at https://opensuse.github.io/daps