Skip to content

Commit

Permalink
Update settings file reference documentation (#111)
Browse files Browse the repository at this point in the history
Signed-off-by: Cintia Sánchez García <cynthiasg@icloud.com>
  • Loading branch information
cynthia-sg authored Oct 18, 2024
1 parent 92e5cb2 commit 4c0db6a
Show file tree
Hide file tree
Showing 20 changed files with 221 additions and 61 deletions.
16 changes: 12 additions & 4 deletions aousd/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,14 @@ analytics:
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -149,7 +154,7 @@ footer:
logo: https://aousd.org/wp-content/uploads/sites/28/2023/07/logo-vertical-white.svg
text: |
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).
# Grid items size (optional)
#
# Defines the preferred size of the landscape items in the grid mode. When the
Expand All @@ -170,6 +175,9 @@ grid_items_size: large
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions aswf/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ url: https://aswf.landscape2.io
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -193,6 +198,9 @@ grid_items_size: medium
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions camara/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ url: https://camara.landscape2.io
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -166,6 +171,9 @@ grid_items_size: large
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions cdf/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ url: https://cdf.landscape2.io
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -189,6 +194,9 @@ grid_items_size: medium
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions cncf/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,14 @@ analytics:
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -209,6 +214,9 @@ grid_items_size: small
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions dlt/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ url: https://dlt.landscape2.io
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -191,6 +196,9 @@ grid_items_size: large
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions graphql/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ url: https://graphql.landscape2.io
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -167,6 +172,9 @@ grid_items_size: large
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions lf/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,14 @@ analytics:
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -187,6 +192,9 @@ grid_items_size: small
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions lfai/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ url: https://lfai.landscape2.io
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -193,6 +198,9 @@ grid_items_size: medium
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions lfenergy/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ url: https://lfenergy.landscape2.io
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -204,6 +209,9 @@ grid_items_size: small
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions lfnetworking/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ url: https://lfnetworking.landscape2.io
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -173,6 +178,9 @@ grid_items_size: large
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions o3df/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ url: https://o3df.landscape2.io
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -176,6 +181,9 @@ grid_items_size: large
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
14 changes: 11 additions & 3 deletions omp/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ url: https://omp.landscape2.io
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
# This option can also be used to not display one or more subcategories in some
# sections of the landscape [*]. To achieve that, we only need to exclude the
# subcategory from the subcategories list when overriding a category.
#
# [*]
# - Grid mode: excluded subcategories won't be displayed
# - Card mode: items in excluded subcategories won't be displayed when
# filtering by group or classifying by category
#
# categories:
# - name: <CATEGORY_NAME>
Expand Down Expand Up @@ -198,6 +203,9 @@ grid_items_size: medium
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# When groups are used, categories not listed in any group won't be displayed
# in the grid mode.
#
# groups:
# - name: <GROUP_NAME>
# categories:
Expand Down
Loading

0 comments on commit 4c0db6a

Please sign in to comment.