Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fix links to actually work.
  • Loading branch information
janajaeger authored Feb 24, 2023
1 parent c7b9fad commit a2db0fb
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ The documentation consists of smaller information units with the following chara

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](https://github.com/SUSE/doc-modular/blob/main/templates/xml/assembly.xml)
* Task (how to?) - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/xml/task.xml)
* Concept (what is?) - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/xml/concept.xml)
* Reference (e.g. list of options, table with config files, default settings) - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/xml/reference.xml)
* 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](https://github.com/SUSE/doc-modular/blob/main/templates/xml/glue.xml)
* Assembly (builds the actual "article" from the components listed below) - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/articles/assembly.xml)
* Task (how to?) - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/tasks/task.xml)
* Concept (what is?) - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/concepts/concept.xml)
* Reference (e.g. list of options, table with config files, default settings) - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/reference/reference.xml)
* 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](https://github.com/SUSE/doc-modular/blob/main/templates/glues/glue.xml)


* For re-use in different contexts:
Expand All @@ -28,4 +28,4 @@ The documentation consists of smaller information units with the following chara

# Conventions

For a comprehensive list of conventions for modular docs, turn to the [templates README](https://github.com/SUSE/doc-modular/blob/main/templates/xml/README.md).
For a comprehensive list of conventions for modular docs, turn to the [templates README](https://github.com/SUSE/doc-modular/blob/main/templates/README.md).

0 comments on commit a2db0fb

Please sign in to comment.