Skip to content

SUSE/doc-modular

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c5720d3 · Mar 31, 2023
Nov 9, 2022
Mar 30, 2023
Mar 31, 2023
Mar 30, 2023
Mar 30, 2023
Mar 31, 2023
Mar 27, 2023
Mar 31, 2023
Mar 31, 2023
Mar 31, 2023
Mar 21, 2023
May 4, 2022
Jan 24, 2023
Mar 28, 2023
Mar 21, 2023
Mar 21, 2023
May 11, 2022
May 11, 2022
Oct 6, 2022
May 11, 2022
May 11, 2022
May 11, 2022
Feb 17, 2023
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
Mar 30, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
Mar 27, 2023
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
May 11, 2022
Feb 24, 2023
Mar 31, 2023
Mar 31, 2023
Sep 29, 2022
Jan 25, 2023
Nov 1, 2022

Repository files navigation

Modular Documentation

What is this about?

This repository contains modular documentation for SUSE products. The documentation consists of smaller information units with the following characteristics:

  • Self-contained

    Including requirements, context, instructions, and FAQs. Each information unit is supposed to stand for itself.

  • Cover one distinct purpose:

    Rather than covering a complete technology or a set of problems, each information unit covers only one distinct topic. We provide five different types of information units:

    • Assembly (builds the actual "article" from the components listed below) - XML template
    • Task (how to?) - XML template
    • Concept (what is?) - XML template
    • Reference (e.g. list of options, table with config files, default settings) - XML template
    • Glue (combines texts or structures that do not fit into any of the other categories): Typical glue topics include the intro section to your article, the "For more information" and the "What's next" sections. Also use glue topics to add an additional layer of navigation to your article. - XML template
  • For re-use in different contexts:

    Tasks, concept and reference context units can be re-used in different context. Content units (articles) are built by pulling these together in dedicated assembly files.

Conventions

For a comprehensive list of conventions for modular docs, turn to the templates README.