From c60db21fe39b08a1c07967778989bfe52a996418 Mon Sep 17 00:00:00 2001 From: Stefan Knorr Date: Sat, 20 Feb 2021 19:43:54 +0100 Subject: [PATCH] Update REAMDE, editurls, and issue template after master/main switch --- .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++------- README.adoc | 48 +++++++++++++------------------- xml/MAIN.SLEDS.xml | 4 +-- xml/MAIN.opensuse.xml | 2 +- xml/art_jeos_quickstart.xml | 2 +- xml/art_pcidss.xml | 2 +- xml/art_sles_rpi_quick.xml | 2 +- 7 files changed, 35 insertions(+), 45 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d698864962..58230ab63d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,15 +14,15 @@ Describe the overall goals of this pull request. The first column is to be filled by the requester, the second column is to be filled by the doc team after the changes have been backported to the maintenance branches. | Code 15 | Backport Done -| ---------- | ---------- -| [ ] 15 SP3 | (`master` only) -| [ ] 15 SP2 | [ ] -| [ ] 15 SP1 | [ ] -| [ ] 15 SP0 | [ ] +| ---------- | ---------- +| [ ] 15 SP3 | *(no backport necessary)* +| [ ] 15 SP2 | [ ] +| [ ] 15 SP1 | [ ] +| [ ] 15 SP0 | [ ] | Code 12 | Backport Done -| ---------- | ---------- -| [ ] 12 SP5 | [ ] -| [ ] 12 SP4 | [ ] -| [ ] 12 SP3 | [ ] -| [ ] 12 SP2 | [ ] +| ---------- | ---------- +| [ ] 12 SP5 | [ ] +| [ ] 12 SP4 | [ ] +| [ ] 12 SP3 | [ ] +| [ ] 12 SP2 | [ ] diff --git a/README.adoc b/README.adoc index 314fdf7393..cf0e3b1313 100644 --- a/README.adoc +++ b/README.adoc @@ -1,6 +1,6 @@ = SUSE Linux Enterprise / openSUSE Leap Documentation -image:https://travis-ci.org/SUSE/doc-sle.svg?branch=master["Build Status", link="https://travis-ci.org/SUSE/doc-sle"] +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. @@ -10,56 +10,46 @@ 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 `master` and maintenance branches are automatically built. +Beta documentation versions are available at https://susedoc.github.io/, where all commits to `main` and maintenance branches are automatically built. == Branches -***On Sep 4, 2019, we changed to a new branching model. We have switched the default branch from `develop` to `master`.*** +***On Feb 20, 2021, we switched to a new default branch.*** +***The default branch is now called `main`.*** -* *Use the master branch* as the basis of your commits/of new feature branches. +* *Use the main 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. -=== How to Update Your Local Repository +=== How to update your local repository -If you *created* a local clone or GitHub fork of this repo *before Sep 4, 2019, do the following*: - -1. Make sure that your `master` and `develop` branches do not contain any important changes. - If there are changes on either branch, export them using `git format-patch` or put them on a - different branch. - -1. Go to the master branch: `git checkout master` -. - -1. To pull the latest changes from the remote repository and to delete references to branches - that do not exist anymore on the server, run the following command: `git pull --prune` -. - -1. Delete your local develop branch: `git branch -D develop`. - -1. To check for stale local branches, run: `git branch -v`. - For any branches marked as `[gone]`, check if you still need them. If not, delete them: - `git branch -D BRANCHNAME` +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 -| `master` | doc development (latest development version) +| `main` | doc development (latest development version) | `maintenance/*` | maintenance for released versions | `trans/*` | translations for released versions |================================================ -== Reporting Bugs +== 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 @@ -71,7 +61,7 @@ As component select `Documentation`. 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 `master` branch (not `develop`). The `master` branch is protected. +. 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. @@ -99,7 +89,7 @@ To contribute to the documentation, you need to write DocBook. sudo /sbin/OneClickInstallUI https://gitlab.nue.suse.com/susedoc/doc-ymp/raw/master/Documentation.ymp ---- -* Basic daps usage: +* 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 diff --git a/xml/MAIN.SLEDS.xml b/xml/MAIN.SLEDS.xml index 5fe23c1efa..91f8c9ecc0 100644 --- a/xml/MAIN.SLEDS.xml +++ b/xml/MAIN.SLEDS.xml @@ -47,7 +47,7 @@ PUBLIC SUSE Linux Enterprise Server 15 SP3 fs@suse.com - https://github.com/SUSE/doc-sle/edit/master/xml/ + https://github.com/SUSE/doc-sle/edit/main/xml/ yes @@ -63,7 +63,7 @@ PUBLIC SUSE Linux Enterprise Desktop 15 SP3 fs@suse.com - https://github.com/SUSE/doc-sle/edit/master/xml/ + https://github.com/SUSE/doc-sle/edit/main/xml/ yes diff --git a/xml/MAIN.opensuse.xml b/xml/MAIN.opensuse.xml index e708268fbd..12b30c2162 100644 --- a/xml/MAIN.opensuse.xml +++ b/xml/MAIN.opensuse.xml @@ -27,7 +27,7 @@ fs@suse.com yes - https://github.com/SUSE/doc-sle/edit/master/xml/ + https://github.com/SUSE/doc-sle/edit/main/xml/ diff --git a/xml/art_jeos_quickstart.xml b/xml/art_jeos_quickstart.xml index 8c1797d237..b3c972ce80 100644 --- a/xml/art_jeos_quickstart.xml +++ b/xml/art_jeos_quickstart.xml @@ -23,7 +23,7 @@ SUSE Linux Enterprise Server 15 SP2 dpopov@suse.com - https://github.com/SUSE/doc-sle/edit/master/xml/ + https://github.com/SUSE/doc-sle/edit/main/xml/ no diff --git a/xml/art_pcidss.xml b/xml/art_pcidss.xml index 21184ec150..324ab25f8c 100644 --- a/xml/art_pcidss.xml +++ b/xml/art_pcidss.xml @@ -27,7 +27,7 @@ SUSE Linux Enterprise Server 15 SP2 fs@suse.com - https://github.com/SUSE/doc-sle/edit/master/xml/ + https://github.com/SUSE/doc-sle/edit/main/xml/ no diff --git a/xml/art_sles_rpi_quick.xml b/xml/art_sles_rpi_quick.xml index 6e9e55991b..c8dc9072d8 100644 --- a/xml/art_sles_rpi_quick.xml +++ b/xml/art_sles_rpi_quick.xml @@ -31,7 +31,7 @@ SUSE Linux Enterprise Server 15 SP2 fs@suse.com - https://github.com/SUSE/doc-sle/edit/master/xml/ + https://github.com/SUSE/doc-sle/edit/main/xml/ no