Documentation Release Notes for 4

Latest Changes

4.0 June 6, 2019

4 Changes

Uyuni 4 includes a large number of changes to documents, additional material and a massive volume of qualitative updates.

The following list covers the primary content changes and additions.

Changes During 4
  • xrefs have been fully restored across books

  • Update to left nav bar

  • Update to centOS client docs

  • Add spacewalk-common-channels to Ubuntu client config

  • Proxy setup cleanup

  • Proxy install cleanup

  • Add uyuni/suma example grafana dashboard

  • Explain how comps file are processed

  • Update to the Salt Formula path

  • Salt Mine edits

  • Updated ISS section

  • Updated troubleshooting

  • Updated IBM Z section

  • Updated to Unified Installer in Install Guide and Retail Guide

  • Added Ubuntu Clients

  • New live patching section for SLES 15

  • New Content Staging feature/section

  • Channel-Setup with Autoyast

  • Update - Installing SUSE Manager Proxy Servers

  • Creating Delta Images

  • Update - smdba section

  • Update - Cobbler section

  • Update - Procedure for restoring from a manual backup

  • Update - Formulas with forms

  • The minion-action-cleanup task was added

  • See extensions/xref-converter.rb for converting xrefs into paths within our PDF documents

  • Reference - many xrefs have been updated (Systems and Users tabs remain)

  • Missing images have been restored

  • General editing and clean-up on many documents

Known Issues in 4

xref-converter.rb - (Affects PDF Documents)

Our custom Asciidoctor xref extension converter requires minor refactoring as several links are incorrectly transforming during our PDF conversion. The cross reference styling will seem a little strange in our PDFs until we make the change.

search - (Affects the Product WebUI)

The Algolia search field has been disabled in the Uyuni documentation WebUI. Use the Help → Search page in the WebUI to look for topics. Search will be integrated into the documentation WebUI in an update. Search is available on https:/www.suse.com/documentation/suse-manager-4/.

From https:/www.suse.com/documentation/suse-manager-4/ browse to Uyuni 4.0 Documentation and use the search field to search in real-time through the docs.

RC1 Changes

RC1 includes a massive number of changes to documents, additional material and a large number of qualitative updates.

There are far too many changes to include in the following list but these sufficiently cover the majority of content changes and additions.

Changes During RC1
  • Updated ISS section

  • Updated troubleshooting

  • Updated IBM Z section

  • Updated to Unified Installer in Install Guide and Retail Guide

  • Added Ubuntu Clients

  • New live patching section for SLES 15

  • New Content Staging feature/section

  • Channel-Setup with Autoyast

  • Update - Installing SUSE Manager Proxy Servers

  • Creating Delta Images

  • Update - smdba section

  • Update - Cobbler section

  • Update - Procedure for restoring from a manual backup

  • Update - Formulas with forms

  • The minion-action-cleanup task was added

  • See extensions/xref-converter.rb for converting xrefs into paths within our PDF documents

  • Reference - many xrefs have been updated (Systems and Users tabs remain)

  • Missing images have been restored

  • General editing and clean-up on many documents

Known Issues in RC1

xref-converter.rb

The converter still requires refactoring as several links are incorrectly transforming during PDF conversion.

xrefs

Some cross references are still broken across the books. Fixes for these will be submitted in an update.

Beta 3 Changes

Our focus for Uyuni 4 was to finish shifting the sources from our old IA (Information Architecture) into our new one. The Reference, Installation and Administration guides are now close to where we like them to be.

There are far too many changes to include in the following list but these sufficiently represent the larger changes.

Updated Items

  • Content Lifecycle (REF)

  • Added missing user menu content (REF)

  • Added missing configuration menu content (REF)

  • Added missing systems content (REF, autoinstallation coming soon.)

  • Updated process configuration files (SUMA and Uyuni playbooks)

  • Cleaned up our Makefile

  • Added many missing images (REF, INSTALL and ADMIN)

  • Added/updated missing Ubuntu content (CLIENT CONFIG)

  • Fixed several build errors (INSTALLATION)

  • Package lock notes (REF)

  • Live Patching updates

  • All future documentation will be based off the Master branch

  • Fix req’s discrepancy in install guide

  • Unified Installer - Retail

  • smdba sections need update

  • BZ#1131679 - Updated path for proxy config

  • BZ#1131977 Create Group; (RETAIL)

  • BZ#1131701 Bind formula procedure updated (retail)

  • BZ#1131691 - Best Practices bad link

  • BZ#1131398 - Client Registration

  • BZ#1131398 - Registering Salt clients

  • BZ#1131695 - Bad link in Retail book

Known Issues

Images

Some images might be missing, or might fail to load. This is either because we need to take new screenshots, develop new graphics, or content that has not yet been moved from its old home. These will be corrected in a minor release.

Beta 2 Changes

Updated Documentation Structure

We have received an overwhelming amount of positive feedback about our documentation over the years, but we have also received some excellent ideas for improvement. That is how we know that the content we have is great, but it was sometimes difficult to find. In this release, we have reorganized our documentation and updated our tooling to make it clearer where information is, and make it easier for you to find the content you need, when you need it.

Please keep the feedback coming! In this new layout, you can propose changes directly by clicking the Edit this Page button. You can also report an issue by clicking Report Issue in the Resources menu.

Content Cleanup

All Uyuni books have been reworked into a new structure.

Old Naming Format

  • Getting Started

  • Best Practices

  • Reference

  • Advanced Topics

New Naming Format

  • Installation Guide (Requirements, supported platforms, installation methods, etc)

  • Client Configuration Guide (Configuring and connecting clients to Uyuni)

  • Upgrade Guide (Migrate and update clients and Uyuni)

  • Reference (Comprehensive guide to the Web UI)

  • Administration Guide (Maintenance and administration tasks in SUSE Manager)

  • Salt Guide (A comprehensive guide to Salt for system administrators)

  • Retail Guide (A guide to using SUSE Manager for Retail)

  • Architecture Guide (Details on components, Salt and traditional architectures, and diagrams)

We have added a prototype of real time search using Algolia. We are still developing an alternative for offline reading.

The search feature of this beta release is a prototype and points to development and testing sources.

Antora Static Site

All SUSE Manager documentation is now written in AsciiDoc and built with Antora. This makes it significantly easier for readers to become contributors by being able to edit the page directly in plain text (no more XML!).

Documentation by Version

Beginning with Uyuni 4.0, you will be able to select which version of the documentation you want to view, by using the version switcher at the bottom of the navigation pane.

User Contributions

You may now contribute directly to any document you are currently viewing.

Procedure: Contributing to documentation
  1. Select the Edit this page link (Top right of the document)

  2. You will be directed to Github. Login, make your changes then submit a pull request.

  3. Your request will be reviewed by a technical writer and published.

PDF Output

Draft PDF documents are now available from the documentation index page. Asciidoctor-pdf is currently used to produce PDF documents from our antora nav lists. These documents are draft and should not be used in production.

Faster Publishing

Our new documentation site implements continuous integration with TravisCI. As soon as as change is approved, TravisCI rebuilds the documentation and updates the published version within 3-5 minutes.