forked from SUSE/doc-sle
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
REAMDE: Move branch overview table further up, use Unix line ends
- Loading branch information
Stefan Knorr
committed
Feb 20, 2021
1 parent
c60db21
commit 84ec0bb
Showing
1 changed file
with
100 additions
and
98 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,98 +1,100 @@ | ||
| = SUSE Linux Enterprise / openSUSE Leap Documentation | ||
|
|
||
| image:https://travis-ci.org/SUSE/doc-sle.svg?branch=main["Build Status", link="https://travis-ci.org/SUSE/doc-sle"] | ||
|
|
||
| This is the source for the official SUSE Linux Enterprise and openSUSE Leap | ||
| documentation. | ||
|
|
||
| This repository hosts the documentation sources including translations (if | ||
| available) for the following products: | ||
|
|
||
| * SUSE Linux Enterprise Desktop (SLED) | ||
| * SUSE Linux Enterprise Server (SLES) | ||
| * SUSE Linux Enterprise Micro (SLE-Micro) | ||
| * openSUSE Leap | ||
| Released versions of the SLE documentation are published at | ||
| https://documentation.suse.com/. Released versions of the openSUSE Leap documentation can be | ||
| found at http://doc.opensuse.org/. | ||
|
|
||
| Beta documentation versions are available at https://susedoc.github.io/, where all commits to `main` and maintenance branches are automatically built. | ||
|
|
||
|
|
||
| == 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*: | ||
|
|
||
| [code] | ||
| ==== | ||
| git branch -m master main | ||
| git fetch origin | ||
| git branch -u origin/main main | ||
| git pull -r | ||
| ==== | ||
|
|
||
| .Overview of important branches | ||
| [options="header"] | ||
| |================================================ | ||
| | Name | Purpose | ||
| | `main` | doc development (latest development version) | ||
| | `maintenance/*` | maintenance for released versions | ||
| | `trans/*` | translations for released versions | ||
| |================================================ | ||
|
|
||
| == 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 Desktop` or `Server` as product and in the next step the version. | ||
| As 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. The `main` branch 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 (Travis CI) 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. | ||
|
|
||
| . Implement the required changes. If you have any questions, ping a documentation team member in #susedoc on RocketChat. | ||
|
|
||
| . For help on style and structure, refer to the https://documentation.suse.com/style/current[Documentation Style Guide]. | ||
|
|
||
|
|
||
| == 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-<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 | ||
| ** `$ daps -d DC-<YOUR_BOOK> optipng`: Always optimize new PNG images | ||
| ** Learn more at https://opensuse.github.io/daps | ||
| = SUSE Linux Enterprise / openSUSE Leap Documentation | ||
|
|
||
| image:https://travis-ci.org/SUSE/doc-sle.svg?branch=main["Build Status", link="https://travis-ci.org/SUSE/doc-sle"] | ||
|
|
||
| This is the source for the official SUSE Linux Enterprise and openSUSE Leap | ||
| documentation. | ||
|
|
||
| This repository hosts the documentation sources including translations (if | ||
| available) for the following products: | ||
|
|
||
| * SUSE Linux Enterprise Desktop (SLED) | ||
| * SUSE Linux Enterprise Server (SLES) | ||
| * SUSE Linux Enterprise Micro (SLE-Micro) | ||
| * openSUSE Leap | ||
| Released versions of the SLE documentation are published at | ||
| https://documentation.suse.com/. Released versions of the openSUSE Leap documentation can be | ||
| found at http://doc.opensuse.org/. | ||
|
|
||
| Beta documentation versions are available at https://susedoc.github.io/, where all commits to `main` and maintenance branches are automatically built. | ||
|
|
||
|
|
||
| == 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*: | ||
|
|
||
| [code] | ||
| ==== | ||
| 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 Desktop` or `Server` as product and in the next step the version. | ||
| As 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. The `main` branch 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 (Travis CI) 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. | ||
|
|
||
| . Implement the required changes. If you have any questions, ping a documentation team member in #susedoc on RocketChat. | ||
|
|
||
| . For help on style and structure, refer to the https://documentation.suse.com/style/current[Documentation Style Guide]. | ||
|
|
||
|
|
||
| == 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-<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 | ||
| ** `$ daps -d DC-<YOUR_BOOK> optipng`: Always optimize new PNG images | ||
| ** Learn more at https://opensuse.github.io/daps |