Skip to content

Commit

Permalink
Update REAMDE, editurls, and issue template after master/main switch
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefan Knorr committed Feb 20, 2021
1 parent 493c089 commit c60db21
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 45 deletions.
20 changes: 10 additions & 10 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 | [ ]
48 changes: 19 additions & 29 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand All @@ -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.

Expand Down Expand Up @@ -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-<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
Expand Down
4 changes: 2 additions & 2 deletions xml/MAIN.SLEDS.xml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<dm:product>PUBLIC SUSE Linux Enterprise Server 15 SP3</dm:product>
<dm:assignee>fs@suse.com</dm:assignee>
</dm:bugtracker>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/master/xml/</dm:editurl>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/main/xml/</dm:editurl>
<dm:translation>yes</dm:translation>
</dm:docmanager>
<xi:include href="common_authors.xml"/>
Expand All @@ -63,7 +63,7 @@
<dm:product>PUBLIC SUSE Linux Enterprise Desktop 15 SP3</dm:product>
<dm:assignee>fs@suse.com</dm:assignee>
</dm:bugtracker>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/master/xml/</dm:editurl>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/main/xml/</dm:editurl>
<dm:translation>yes</dm:translation>
</dm:docmanager>
<xi:include href="common_authors.xml"/>
Expand Down
2 changes: 1 addition & 1 deletion xml/MAIN.opensuse.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<dm:assignee>fs@suse.com</dm:assignee>
</dm:bugtracker>
<dm:translation>yes</dm:translation>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/master/xml/</dm:editurl>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/main/xml/</dm:editurl>
</dm:docmanager>
</info>
<!-- Start-Up -->
Expand Down
2 changes: 1 addition & 1 deletion xml/art_jeos_quickstart.xml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<dm:product>SUSE Linux Enterprise Server 15 SP2</dm:product>
<dm:assignee>dpopov@suse.com</dm:assignee>
</dm:bugtracker>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/master/xml/</dm:editurl>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/main/xml/</dm:editurl>
<dm:translation>no</dm:translation>
</dm:docmanager>
<abstract>
Expand Down
2 changes: 1 addition & 1 deletion xml/art_pcidss.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<dm:product>SUSE Linux Enterprise Server 15 SP2</dm:product>
<dm:assignee>fs@suse.com</dm:assignee>
</dm:bugtracker>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/master/xml/</dm:editurl>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/main/xml/</dm:editurl>
<dm:translation>no</dm:translation>
</dm:docmanager>
<!-- abstract: -->
Expand Down
2 changes: 1 addition & 1 deletion xml/art_sles_rpi_quick.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<dm:product>SUSE Linux Enterprise Server 15 SP2</dm:product>
<dm:assignee>fs@suse.com</dm:assignee>
</dm:bugtracker>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/master/xml/</dm:editurl>
<dm:editurl>https://github.com/SUSE/doc-sle/edit/main/xml/</dm:editurl>
<dm:translation>no</dm:translation>
</dm:docmanager>
<abstract>
Expand Down

0 comments on commit c60db21

Please sign in to comment.