= Uyuni Documentation Repository ifdef::env-github,backend-html5[] //Admonitions :tip-caption: :bulb: :note-caption: :information_source: :important-caption: :heavy_exclamation_mark: :caution-caption: :fire: :warning-caption: :warning: :linkattrs: // SUSE ENTITIES FOR GITHUB // System Architecture :zseries: z Systems :ppc: POWER :ppc64le: ppc64le :ipf : Itanium :x86: x86 :x86_64: x86_64 // Rhel Entities :rhel: Red Hat Enterprise Linux :rhnminrelease6: Red Hat Enterprise Linux Server 6 :rhnminrelease7: Red Hat Enterprise Linux Server 7 // SUSE Manager Entities :susemgr: SUSE Manager :susemgrproxy: SUSE Manager Proxy :productnumber: 3.2 :saltversion: 2018.3.0 :webui: WebUI // SUSE Product Entities :sles-version: 12 :sp-version: SP3 :jeos: JeOS :scc: SUSE Customer Center :sls: SUSE Linux Enterprise Server :sle: SUSE Linux Enterprise :slsa: SLES :suse: SUSE :ay: AutoYaST endif::[] // Asciidoctor Front Matter :doctype: book :sectlinks: :icons: font :experimental: :sourcedir: . :imagesdir: images
== Statuses and artifacts
=== Build and archive
==== Development branches
[cols="1,1"]
|===
|master
|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/build_and_archive_devel_docs.yml/badge.svg?branch=master["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/build_and_archive_devel_docs.yml"]
|manager-5.0
|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/build_and_archive_devel_docs.yml/badge.svg?branch=manager-5.0["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/build_and_archive_devel_docs.yml"]
|manager-4.3
|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/build_and_archive_devel_docs.yml/badge.svg?branch=manager-4.3["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/build_and_archive_devel_docs.yml"]
|===
==== Release branches
https://github.com/uyuni-project/uyuni-docs/actions/workflows/build_and_archive_release_docs.yml[Builds and Artifacts]
=== Find unused files
[cols="1,1"]
|===
|master
|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/find_unused_files.yml/badge.svg?branch=master["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/find_unused_files.yml"]
|manager-5.0
|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/find_unused_files.yml/badge.svg?branch=manager-5.0["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/find_unused_files.yml"]
|manager-4.3
|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/find_unused_files.yml/badge.svg?branch=manager-4.3["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/find_unused_files.yml"]
|===
//=== Linting
//[cols="1,1"]
//|===
//|master
//|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/linting.yml/badge.svg?branch=master["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows///linting.yml"]
//
//|manager-4.3
//|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/linting.yml/badge.svg?branch=manager-4.3["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/linting.yml"]
//|===
//=== Enforced checkstyle
//[cols="1,1"]
//|===
//|master
//|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/enforced_checkstyle.yml/badge.svg?branch=master["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows///enforced_checkstyle.yml"]
//
//|manager-4.3
//|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/enforced_checkstyle.yml/badge.svg?branch=manager-4.3["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/enforced_checkstyle.yml"]
//|===
=== Update translation files
[cols="1,1"]
|===
|master
|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/update_translation_files.yml/badge.svg?branch=master["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/update_translation_files.yml"]
|===
=== Test PDF translations
Note: en
is not include as part of this test, as it is built as part of the Build and archive documentation from branches
test.
[cols="1,1"]
|===
|master
|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/test_pdf_translations.yml/badge.svg?branch=master["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/test_pdf_translations.yml"]
|manager-4.3
|image:https://github.com/uyuni-project/uyuni-docs/actions/workflows/test_pdf_translations.yml/badge.svg?branch=manager-4.3["Build Status", link="https://github.com/uyuni-project/uyuni-docs/actions/workflows/test_pdf_translations.yml"]
|===
[suma.doc.intro] == Introduction This is the source for the official Uyuni and SUSE Manager documentation. We welcome pull requests.
For more details on contributing to Uyuni documentation, visit the https://github.com/uyuni-project/uyuni-docs/wiki[Uyuni Documentation Wiki]. The wiki contains information about word usage, markup conventions, team processes, our docs toolchain, building locally, and publishing documentation. It also contains project planning information.
[suma.doc.first.contribution] == First Contribution
To contribute to Uyuni documentation:
.Procedure: Configure Git commit signing (if needed) . Signing commits with a GPG/SSH key is mandatory for contributing. That way your commits will be marked as verified on GitHub so other people can be confident that the changes come from a trusted source. . If you are not doing it already, check out the https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification[GitHub documentation].
re signed in. . Navigate to the [Uyuni Documentation Repo](https://github.com/uyuni-project/uyuni-docs.git), click the
Forkbutton in the top-right corner, and select the account you want to use. . Wait for github to create your fork and redirect you. . Clone the repository to your local machine. To find this URL, click the green
Code` button and copy the HTTPS URL:
+/master
branch:
+origin
, like this:
+origin
remotes are your own fork, and you can do whatever you want here without changing the upstream repository.
. Add the uyuni-docs repo as an upstream:
+origin
remotes as before, plus two more labelled upstream
, like this:
+master
branch:
+master
branch, into your fork's master
branch:
+If you have write access to the repository, use this method instead:
/master
branch:
+Regardless of whether you use a fork or commit directly, when you have made your changes you can make a pull request (PR). Always check that your changes build locally first.
. Create a pull request (PR) by navigating to https://github.com/uyuni-project/uyuni-docs and clicking [btn]Compare and Create Pull Request
.
Write an informative commit message detailing your changes, choose reviewers, and save your PR.
If you haven't yet finished the work you want to do, make sure you create a Draft PR by selecting it from the drop down box in the github web UI.
This lets your reviewers know that you haven't finished work yet, while still being transparent about what you are working on, and making sure we all understand current progress.
.Review Standards
These standards ensure that our documentation is accurate, that PRs are not left to age, and that the source code remains clean. Ensure you follow these standards if you are participating in the Uyuni documentation repository.
[WIP]
to the title of your PR.
This allows people to review the PR, but notifies reviewers that you have not completed work.[suma.doc.second.contribution] == Second Contribution
Once you have checked out the repo and want to keep working on things, you need to ensure that your local copy of the repo remains up to date. If you don't do this, you will end up with merge conflicts.
master
branch:
+master
branch, into your fork's master
branch:
+. If you are continuing work you began earlier, check out the branch that contains your work. For new work, create a new branch.
/master
branch:
+. If you are continuing work you began earlier, check out the branch that contains your work. For new work, create a new branch.
Doing this regularly as you are working will mean you keep your local copies up to date and avoid conflicts. You should do it at least every day before you begin work, and again whenever you switch branches.
For example, you are working on two separate pieces of content, one in the feature_1
branch, and the other in the feature_2
branch:
Compare and Create Pull Request
.
Write an informative commit message detailing your changes, choose reviewers, and save your PR.
If you haven't yet finished the work you want to do on Feature 1, make sure you create a Draft PR by selecting it from the drop down box in the github web UI.
That way, you can come back to Feature 1 later on.
. Switch your local copy back to master, and update your local copy again:
+. When you are finished on Feature 2, commit your changes and create another PR, just the same as you did for Feature 1.
== Changelog Entries
Write your changes to the CHANGELOG.md
file. New entries are added to the top, in the following format. Each collection of release entries should be separated by dashed lines. These lines are used to extract the automated changelog notes for releases.
For guidelines: https://en.opensuse.org/openSUSE:Creating_a_changes_file_(RPM)
[suma.docs.team] == The Uyuni Documentation Team