SUSE Best Practices

A documentation series of best practices papers.

Branches

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

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 protected.

• Make sure all validation (Travis CI) checks are passed, and tag relevant SMEs from the development team (if applicable) and members of the SUSE Best Practices team: Meike Chabowski (@chabowski).

  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 and are a SUSE employee, ping a documentation team member in #team-suse-docs on Slack.

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 multi-page HTML document

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

Published Documents

Papers not produced by documentation team which exist only as PDF (no DC file available) but need to be posted:

Category "SUSE Linux Enterprise Server for SAP"

• Setting up a SAP HANA SR Performance Optimized Infrastructure (SLES-SAP 11 SP4) https://www.suse.com/media/guide/sap_hana_sr_performance_optimized_scenario_11_sp4.pdf also link from product page: https://documentation.suse.com/sles-sap-11/

• Setting up a SAP HANA SR Cost Optimized Infrastructure (SLES-SAP 11 SP4) https://www.suse.com/media/guide/sap_hana_sr_cost_optimized_scenario_11_sp4.pdf also link from product page: https://documentation.suse.com/sles-sap-11/

• Setting up a SAP HANA SR Cost Optimized Infrastructure (SLES-SAP 12 SP1) https://www.suse.com/media/white-paper/sap_hana_sr_cost_optimized_scenario_12_sp1.pdf also link from product page: https://documentation.suse.com/sles-sap-12/

• Enqueue Replication - SAP NetWeaver High Availability on SUSE Linux Enterprise 12 (SP1 or newer) https://www.suse.com/media/guide/SLES4SAP-NetWeaver-ha-guide-EnqRepl-12_color_en.pdf also link from product page: https://documentation.suse.com/sles-sap-12/

• Simple Stack - SAP NetWeaver High Availability on SUSE Linux Enterprise 12 (SP1 or newer) https://www.suse.com/media/guide/simple_stack_sap_netweaver_high_availablity_on_suse_linux_enterprise_server_12.pdf also link from product page: https://documentation.suse.com/sles-sap-12/

• Operating System Security Hardening Guide for SAP HANA for SUSE Linux Enterprise Server 12 https://www.suse.com/media/guide/operating_system_security_hardening_guide_for_sap_hana_for_suse_linux_enterprise_server_12.pdf also link from product page: https://documentation.suse.com/sles-sap-12/

• Operating System Security Hardening Guide for SAP HANA for SUSE Linux Enterprise Server 15 https://www.suse.com/media/guide/Operatin_system_security_hardening_guide_for_sap_hana_for_suse_linux_enterprise_server_15.pdf also link from product page: https://documentation.suse.com/sles-sap-15/