Skip to content

Commit b826f54

Browse files
authored
FCCEUD-15 Describe assemblies (#517)
* WIP con_about-assemblies * minor * revised * Revised * Revised
1 parent ec28c33 commit b826f54

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// <List assemblies here, each on a new line>
4+
5+
6+
7+
[id="con_about-assemblies_{context}"]
8+
= Overview of assemblies
9+
:_module-type: CONCEPT
10+
11+
[role="_abstract"]
12+
In {ProductName} {ProdctNumber}, each assembly encompasses a single user story. This is a key element of the Flexible Customer Content (FCC) effort at Red Hat. An assembly can include concept, procedure, or reference modules but all modules in an assembly must relate to that specific user story.
13+
14+
Previously, a single assembly, such as the master.adoc for a user guide, could include a number of user stories without affecting search results However, in {ProductName} {ProductNumber}, it is important to limit each assembly to a single user story in order to make it easier for users to search for a specific action they want to perform.
15+
16+
If a user story includes several actions, each action should have its own module. For example, migrating a storage domain is a user story. Part of that story could be described in a module named "Backing up a storage domain" and another part in a module named "Restoring a storage domain."
17+
18+
Assemblies in {ProductName} {ProductNumber} must conform with the following guidelines, in addition to those that apply to documentation in general:
19+
20+
* Existing assemblies that relate to more than one user story must be broken down into assemblies that describe one user story each.
21+
* Nesting assemblies is currently not supported but will be in the future.
22+
* Each assembly relates to a single product. Although a specific solution for a customer might involve a combination of several products, {ProductName} {ProductNumber} currently only supports single-product searches. It is expected that later versions of {ProductName} will support multi-product searches, allowing assemblies that include modules relating to different products.
23+
24+
[role="_additional-resources"]
25+
.Additional resources
26+
27+
Link:https://redhat-documentation.github.io/modular-docs/#forming-assemblies[Assemblies in Red Hat documentation]

0 commit comments

Comments
 (0)