Skip to content

Commit 4c0db6a

Browse files
authored
Update settings file reference documentation (#111)
Signed-off-by: Cintia Sánchez García <cynthiasg@icloud.com>
1 parent 92e5cb2 commit 4c0db6a

20 files changed

Lines changed: 221 additions & 61 deletions

File tree

‎aousd/settings.yml‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,14 @@ analytics:
4646
# specific order within a category (this happens often in the Members category).
4747
# In those cases, it is possible to define that order by overriding a category.
4848
#
49-
# This option can also be used to not display one or more subcategories in the
50-
# landscape. To achieve that, we only need to exclude the subcategory from the
51-
# subcategories list when overriding a category.
49+
# This option can also be used to not display one or more subcategories in some
50+
# sections of the landscape [*]. To achieve that, we only need to exclude the
51+
# subcategory from the subcategories list when overriding a category.
52+
#
53+
# [*]
54+
# - Grid mode: excluded subcategories won't be displayed
55+
# - Card mode: items in excluded subcategories won't be displayed when
56+
# filtering by group or classifying by category
5257
#
5358
# categories:
5459
# - name: <CATEGORY_NAME>
@@ -149,7 +154,7 @@ footer:
149154
logo: https://aousd.org/wp-content/uploads/sites/28/2023/07/logo-vertical-white.svg
150155
text: |
151156
Copyright © Alliance for OpenUSD. All rights reserved. Alliance for OpenUSD is a [Joint Development Foundation Project](https://jointdevelopment.org/), an affiliate of the [Linux Foundation](https://www.linuxfoundation.org/). [Privacy Policy](https://jointdevelopment.org/terms) and [Terms of Use](https://jointdevelopment.org/terms).
152-
157+
153158
# Grid items size (optional)
154159
#
155160
# Defines the preferred size of the landscape items in the grid mode. When the
@@ -170,6 +175,9 @@ grid_items_size: large
170175
# name of the group (it will be displayed as is) and a list with the categories
171176
# (as defined in the landscape.yml data file) that will be part of this group.
172177
#
178+
# When groups are used, categories not listed in any group won't be displayed
179+
# in the grid mode.
180+
#
173181
# groups:
174182
# - name: <GROUP_NAME>
175183
# categories:

‎aswf/settings.yml‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,14 @@ url: https://aswf.landscape2.io
4747
# specific order within a category (this happens often in the Members category).
4848
# In those cases, it is possible to define that order by overriding a category.
4949
#
50-
# This option can also be used to not display one or more subcategories in the
51-
# landscape. To achieve that, we only need to exclude the subcategory from the
52-
# subcategories list when overriding a category.
50+
# This option can also be used to not display one or more subcategories in some
51+
# sections of the landscape [*]. To achieve that, we only need to exclude the
52+
# subcategory from the subcategories list when overriding a category.
53+
#
54+
# [*]
55+
# - Grid mode: excluded subcategories won't be displayed
56+
# - Card mode: items in excluded subcategories won't be displayed when
57+
# filtering by group or classifying by category
5358
#
5459
# categories:
5560
# - name: <CATEGORY_NAME>
@@ -193,6 +198,9 @@ grid_items_size: medium
193198
# name of the group (it will be displayed as is) and a list with the categories
194199
# (as defined in the landscape.yml data file) that will be part of this group.
195200
#
201+
# When groups are used, categories not listed in any group won't be displayed
202+
# in the grid mode.
203+
#
196204
# groups:
197205
# - name: <GROUP_NAME>
198206
# categories:

‎camara/settings.yml‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,14 @@ url: https://camara.landscape2.io
4747
# specific order within a category (this happens often in the Members category).
4848
# In those cases, it is possible to define that order by overriding a category.
4949
#
50-
# This option can also be used to not display one or more subcategories in the
51-
# landscape. To achieve that, we only need to exclude the subcategory from the
52-
# subcategories list when overriding a category.
50+
# This option can also be used to not display one or more subcategories in some
51+
# sections of the landscape [*]. To achieve that, we only need to exclude the
52+
# subcategory from the subcategories list when overriding a category.
53+
#
54+
# [*]
55+
# - Grid mode: excluded subcategories won't be displayed
56+
# - Card mode: items in excluded subcategories won't be displayed when
57+
# filtering by group or classifying by category
5358
#
5459
# categories:
5560
# - name: <CATEGORY_NAME>
@@ -166,6 +171,9 @@ grid_items_size: large
166171
# name of the group (it will be displayed as is) and a list with the categories
167172
# (as defined in the landscape.yml data file) that will be part of this group.
168173
#
174+
# When groups are used, categories not listed in any group won't be displayed
175+
# in the grid mode.
176+
#
169177
# groups:
170178
# - name: <GROUP_NAME>
171179
# categories:

‎cdf/settings.yml‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,14 @@ url: https://cdf.landscape2.io
4747
# specific order within a category (this happens often in the Members category).
4848
# In those cases, it is possible to define that order by overriding a category.
4949
#
50-
# This option can also be used to not display one or more subcategories in the
51-
# landscape. To achieve that, we only need to exclude the subcategory from the
52-
# subcategories list when overriding a category.
50+
# This option can also be used to not display one or more subcategories in some
51+
# sections of the landscape [*]. To achieve that, we only need to exclude the
52+
# subcategory from the subcategories list when overriding a category.
53+
#
54+
# [*]
55+
# - Grid mode: excluded subcategories won't be displayed
56+
# - Card mode: items in excluded subcategories won't be displayed when
57+
# filtering by group or classifying by category
5358
#
5459
# categories:
5560
# - name: <CATEGORY_NAME>
@@ -189,6 +194,9 @@ grid_items_size: medium
189194
# name of the group (it will be displayed as is) and a list with the categories
190195
# (as defined in the landscape.yml data file) that will be part of this group.
191196
#
197+
# When groups are used, categories not listed in any group won't be displayed
198+
# in the grid mode.
199+
#
192200
# groups:
193201
# - name: <GROUP_NAME>
194202
# categories:

‎cncf/settings.yml‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,14 @@ analytics:
5050
# specific order within a category (this happens often in the Members category).
5151
# In those cases, it is possible to define that order by overriding a category.
5252
#
53-
# This option can also be used to not display one or more subcategories in the
54-
# landscape. To achieve that, we only need to exclude the subcategory from the
55-
# subcategories list when overriding a category.
53+
# This option can also be used to not display one or more subcategories in some
54+
# sections of the landscape [*]. To achieve that, we only need to exclude the
55+
# subcategory from the subcategories list when overriding a category.
56+
#
57+
# [*]
58+
# - Grid mode: excluded subcategories won't be displayed
59+
# - Card mode: items in excluded subcategories won't be displayed when
60+
# filtering by group or classifying by category
5661
#
5762
# categories:
5863
# - name: <CATEGORY_NAME>
@@ -209,6 +214,9 @@ grid_items_size: small
209214
# name of the group (it will be displayed as is) and a list with the categories
210215
# (as defined in the landscape.yml data file) that will be part of this group.
211216
#
217+
# When groups are used, categories not listed in any group won't be displayed
218+
# in the grid mode.
219+
#
212220
# groups:
213221
# - name: <GROUP_NAME>
214222
# categories:

‎dlt/settings.yml‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,14 @@ url: https://dlt.landscape2.io
4747
# specific order within a category (this happens often in the Members category).
4848
# In those cases, it is possible to define that order by overriding a category.
4949
#
50-
# This option can also be used to not display one or more subcategories in the
51-
# landscape. To achieve that, we only need to exclude the subcategory from the
52-
# subcategories list when overriding a category.
50+
# This option can also be used to not display one or more subcategories in some
51+
# sections of the landscape [*]. To achieve that, we only need to exclude the
52+
# subcategory from the subcategories list when overriding a category.
53+
#
54+
# [*]
55+
# - Grid mode: excluded subcategories won't be displayed
56+
# - Card mode: items in excluded subcategories won't be displayed when
57+
# filtering by group or classifying by category
5358
#
5459
# categories:
5560
# - name: <CATEGORY_NAME>
@@ -191,6 +196,9 @@ grid_items_size: large
191196
# name of the group (it will be displayed as is) and a list with the categories
192197
# (as defined in the landscape.yml data file) that will be part of this group.
193198
#
199+
# When groups are used, categories not listed in any group won't be displayed
200+
# in the grid mode.
201+
#
194202
# groups:
195203
# - name: <GROUP_NAME>
196204
# categories:

‎graphql/settings.yml‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,14 @@ url: https://graphql.landscape2.io
4747
# specific order within a category (this happens often in the Members category).
4848
# In those cases, it is possible to define that order by overriding a category.
4949
#
50-
# This option can also be used to not display one or more subcategories in the
51-
# landscape. To achieve that, we only need to exclude the subcategory from the
52-
# subcategories list when overriding a category.
50+
# This option can also be used to not display one or more subcategories in some
51+
# sections of the landscape [*]. To achieve that, we only need to exclude the
52+
# subcategory from the subcategories list when overriding a category.
53+
#
54+
# [*]
55+
# - Grid mode: excluded subcategories won't be displayed
56+
# - Card mode: items in excluded subcategories won't be displayed when
57+
# filtering by group or classifying by category
5358
#
5459
# categories:
5560
# - name: <CATEGORY_NAME>
@@ -167,6 +172,9 @@ grid_items_size: large
167172
# name of the group (it will be displayed as is) and a list with the categories
168173
# (as defined in the landscape.yml data file) that will be part of this group.
169174
#
175+
# When groups are used, categories not listed in any group won't be displayed
176+
# in the grid mode.
177+
#
170178
# groups:
171179
# - name: <GROUP_NAME>
172180
# categories:

‎lf/settings.yml‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,14 @@ analytics:
5050
# specific order within a category (this happens often in the Members category).
5151
# In those cases, it is possible to define that order by overriding a category.
5252
#
53-
# This option can also be used to not display one or more subcategories in the
54-
# landscape. To achieve that, we only need to exclude the subcategory from the
55-
# subcategories list when overriding a category.
53+
# This option can also be used to not display one or more subcategories in some
54+
# sections of the landscape [*]. To achieve that, we only need to exclude the
55+
# subcategory from the subcategories list when overriding a category.
56+
#
57+
# [*]
58+
# - Grid mode: excluded subcategories won't be displayed
59+
# - Card mode: items in excluded subcategories won't be displayed when
60+
# filtering by group or classifying by category
5661
#
5762
# categories:
5863
# - name: <CATEGORY_NAME>
@@ -187,6 +192,9 @@ grid_items_size: small
187192
# name of the group (it will be displayed as is) and a list with the categories
188193
# (as defined in the landscape.yml data file) that will be part of this group.
189194
#
195+
# When groups are used, categories not listed in any group won't be displayed
196+
# in the grid mode.
197+
#
190198
# groups:
191199
# - name: <GROUP_NAME>
192200
# categories:

‎lfai/settings.yml‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,14 @@ url: https://lfai.landscape2.io
4747
# specific order within a category (this happens often in the Members category).
4848
# In those cases, it is possible to define that order by overriding a category.
4949
#
50-
# This option can also be used to not display one or more subcategories in the
51-
# landscape. To achieve that, we only need to exclude the subcategory from the
52-
# subcategories list when overriding a category.
50+
# This option can also be used to not display one or more subcategories in some
51+
# sections of the landscape [*]. To achieve that, we only need to exclude the
52+
# subcategory from the subcategories list when overriding a category.
53+
#
54+
# [*]
55+
# - Grid mode: excluded subcategories won't be displayed
56+
# - Card mode: items in excluded subcategories won't be displayed when
57+
# filtering by group or classifying by category
5358
#
5459
# categories:
5560
# - name: <CATEGORY_NAME>
@@ -193,6 +198,9 @@ grid_items_size: medium
193198
# name of the group (it will be displayed as is) and a list with the categories
194199
# (as defined in the landscape.yml data file) that will be part of this group.
195200
#
201+
# When groups are used, categories not listed in any group won't be displayed
202+
# in the grid mode.
203+
#
196204
# groups:
197205
# - name: <GROUP_NAME>
198206
# categories:

‎lfenergy/settings.yml‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,14 @@ url: https://lfenergy.landscape2.io
4747
# specific order within a category (this happens often in the Members category).
4848
# In those cases, it is possible to define that order by overriding a category.
4949
#
50-
# This option can also be used to not display one or more subcategories in the
51-
# landscape. To achieve that, we only need to exclude the subcategory from the
52-
# subcategories list when overriding a category.
50+
# This option can also be used to not display one or more subcategories in some
51+
# sections of the landscape [*]. To achieve that, we only need to exclude the
52+
# subcategory from the subcategories list when overriding a category.
53+
#
54+
# [*]
55+
# - Grid mode: excluded subcategories won't be displayed
56+
# - Card mode: items in excluded subcategories won't be displayed when
57+
# filtering by group or classifying by category
5358
#
5459
# categories:
5560
# - name: <CATEGORY_NAME>
@@ -204,6 +209,9 @@ grid_items_size: small
204209
# name of the group (it will be displayed as is) and a list with the categories
205210
# (as defined in the landscape.yml data file) that will be part of this group.
206211
#
212+
# When groups are used, categories not listed in any group won't be displayed
213+
# in the grid mode.
214+
#
207215
# groups:
208216
# - name: <GROUP_NAME>
209217
# categories:

0 commit comments

Comments
 (0)