You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/antora-site-structure.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ The main reasons for using [Antora][link-antora] are the following:
27
27
* As an example, defining tables is so much easier in asciidoc compared to using markdown.
28
28
* Using attributes (variables), which scope can be easily determined, content can be dynamically defined.
29
29
30
-
2. It extends asciidoc with [multi-repo][link-playbook] capabilities. This is done in a way where any issues identified can be easily tracked down to the sorce where this happens.
30
+
2. It extends asciidoc with [multi-repo][link-playbook] capabilities. This is done in a way where any issues identified can be easily tracked down to the source where this happens.
31
31
32
32
3. The doc writer does not need to care about repos, or content locations, etc. anymore as this is virtualized by Antora and content can be accessed in a standardized way via [Resource ID Coordinates](https://docs.antora.org/antora/latest/page/resource-id-coordinates/).
33
33
@@ -65,7 +65,7 @@ Note that this behaviour is relevant for the playbook `site.yml` files only and
65
65
66
66
### Scope of attributes (site.yml
67
67
68
-
With the use of the `load-global-site-attributes` extension, common attributes are not needed to be maintained for each repo individually. These attributes are defined in the docs repo and are, if defined in the content providing repo, sourced from there. In addition, if necessary, you can re-define attributes in a repo which will then overwrite global attributes if exists. This makes local building very comftable. You can also source for testing 'global' attributes from a local file instead loading it from docs.
68
+
With the use of the `load-global-site-attributes` extension, common attributes are not needed to be maintained for each repo individually. These attributes are defined in the docs repo and are, if defined in the content providing repo, sourced from there. In addition, if necessary, you can re-define attributes in a repo which will then overwrite global attributes if exists. This makes local building very comfortable. You can also source for testing 'global' attributes from a local file instead loading it from docs.
69
69
70
70
If there are any global attributes that need to be updated after a merge of a particular content repo, an additional PR in the docs repo needs to be created to make that change globally available.
71
71
@@ -74,7 +74,7 @@ If there are any global attributes that need to be updated after a merge of a pa
74
74
Because Antora is capable of defining additional content sources, you can access content from these resources. The setup is flat, no main/child environment. To access resources, follow the [Resource ID Coordinates][link-resource-id] scheme.
75
75
76
76
**IMPORTANT:**\
77
-
The following scheme will be bidirectional and restrictions will go away when updating to Antora 3.2 and using the Antora Atlas extension wich will provide a content manifest.
77
+
The following scheme will be bidirectional and restrictions will go away when updating to Antora 3.2 and using the Antora Atlas extension which will provide a content manifest.
78
78
79
79
Because of the setup we have made regarding testing, the direction of the arrow is important.
80
80
@@ -142,7 +142,7 @@ Note that Node related stuff is not mentioned explicitly:
142
142
143
143
```
144
144
.drone.star Define the build process steps when triggered by a PR
145
-
package.json Define the antora environment und scripts to run at the cli
145
+
package.json Define the antora environment and scripts to run at the cli
146
146
antora.yml Contains definitions and attributes that only belong
147
147
to the respective component (version dependent!)
148
148
site.yml Global site definitions, attributes defined overwrite global ones
Copy file name to clipboardExpand all lines: docs/getting-started.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -203,7 +203,7 @@ The branching workflow is only necessary for versioned repos (documentations). P
203
203
204
204
## Backporting
205
205
206
-
If you want or need to backport of a merged PR, you can easily do that by using the linked [backport](../bin/git_commands/backport.sh) script. In the repo where the backport is needed, update the branch containing the merged PR and copy the merge commit. Run the command using the merge commit ID with the target branch where the backport needs to be applied to. All individual commits of the merge will be backported.
206
+
If you want or need to backport a merged PR, you can easily do that by using the linked [backport](../bin/git_commands/backport.sh) script. In the repo where the backport is needed, update the branch containing the merged PR and copy the merge commit. Run the command using the merge commit ID with the target branch where the backport needs to be applied to. All individual commits of the merge will be backported.
207
207
208
208
Note that it may occur that you have conflicts, resolve them first with standard git methods to proceed.
209
209
@@ -218,7 +218,7 @@ Open the `~/.gitconfig` file with the editor of your choice and add the followin
0 commit comments