Documentation Release Notes for Version 4.0

Latest Changes

V4.0 March 1, 2019

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. Otherwise, you can always email us at TBD@suse.de TODO:: check email address

Do not use this documentation for production! The documentation on this site is being offered as a preview of changes to come. They are for testing purposes only.

Goals for this Release

Content Cleanup

All SUSE Manager 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 SUSE Manager)

  • Upgrade Guide (Migrate and update clients and SUSE Manager)

  • Reference Manual (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)

  • Architecture (Details on components, salt/traditional architectures, and diagrams)

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

Do not use this feature for production! The search feature is currently 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 SUSE Manager 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.

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.

Known Issues

PDF Output

We do not currently have PDF versions of books available. This is expected in the beta2 release.

Cross references

Cross references between docs are not currently working as expected, as a result of the conversion process. During the beta, the correct references will be added and these will begin to work correctly.

Missing Content

You might notice some placeholder text or blank pages in some sections. This is either content that we have not yet written, or content that has not yet been moved from its old home. These will be corrected during the beta.

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 during the beta.