From 4c0db6a19266cdb4ff473b877ff865eff8e2ab8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cintia=20S=C3=A1nchez=20Garc=C3=ADa?= Date: Fri, 18 Oct 2024 10:51:15 +0200 Subject: [PATCH] Update settings file reference documentation (#111) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Cintia Sánchez García --- aousd/settings.yml | 16 ++++++++++++---- aswf/settings.yml | 14 +++++++++++--- camara/settings.yml | 14 +++++++++++--- cdf/settings.yml | 14 +++++++++++--- cncf/settings.yml | 14 +++++++++++--- dlt/settings.yml | 14 +++++++++++--- graphql/settings.yml | 14 +++++++++++--- lf/settings.yml | 14 +++++++++++--- lfai/settings.yml | 14 +++++++++++--- lfenergy/settings.yml | 14 +++++++++++--- lfnetworking/settings.yml | 14 +++++++++++--- o3df/settings.yml | 14 +++++++++++--- omp/settings.yml | 14 +++++++++++--- openssf/settings.yml | 14 +++++++++++--- ospo/settings.yml | 14 +++++++++++--- overturemaps/settings.yml | 14 +++++++++++--- pqca/settings.yml | 14 +++++++++++--- presto/settings.yml | 14 +++++++++++--- riscv/settings.yml | 14 +++++++++++--- spdx/settings.yml | 14 +++++++++++--- 20 files changed, 221 insertions(+), 61 deletions(-) diff --git a/aousd/settings.yml b/aousd/settings.yml index 670b530..db7d458 100644 --- a/aousd/settings.yml +++ b/aousd/settings.yml @@ -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: @@ -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 @@ -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: # categories: diff --git a/aswf/settings.yml b/aswf/settings.yml index 52aa6b7..e825f0c 100644 --- a/aswf/settings.yml +++ b/aswf/settings.yml @@ -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: @@ -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: # categories: diff --git a/camara/settings.yml b/camara/settings.yml index ef8f3c1..f5e7888 100644 --- a/camara/settings.yml +++ b/camara/settings.yml @@ -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: @@ -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: # categories: diff --git a/cdf/settings.yml b/cdf/settings.yml index cff65e1..08f7895 100644 --- a/cdf/settings.yml +++ b/cdf/settings.yml @@ -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: @@ -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: # categories: diff --git a/cncf/settings.yml b/cncf/settings.yml index c90029b..30b45fe 100644 --- a/cncf/settings.yml +++ b/cncf/settings.yml @@ -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: @@ -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: # categories: diff --git a/dlt/settings.yml b/dlt/settings.yml index 3e62bbc..ad56768 100644 --- a/dlt/settings.yml +++ b/dlt/settings.yml @@ -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: @@ -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: # categories: diff --git a/graphql/settings.yml b/graphql/settings.yml index 119ec28..7bf9919 100644 --- a/graphql/settings.yml +++ b/graphql/settings.yml @@ -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: @@ -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: # categories: diff --git a/lf/settings.yml b/lf/settings.yml index c7e962c..648ee4c 100644 --- a/lf/settings.yml +++ b/lf/settings.yml @@ -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: @@ -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: # categories: diff --git a/lfai/settings.yml b/lfai/settings.yml index 98255a5..c9a5a11 100644 --- a/lfai/settings.yml +++ b/lfai/settings.yml @@ -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: @@ -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: # categories: diff --git a/lfenergy/settings.yml b/lfenergy/settings.yml index c0bc093..b8d000a 100644 --- a/lfenergy/settings.yml +++ b/lfenergy/settings.yml @@ -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: @@ -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: # categories: diff --git a/lfnetworking/settings.yml b/lfnetworking/settings.yml index eed5e1f..fadbba4 100644 --- a/lfnetworking/settings.yml +++ b/lfnetworking/settings.yml @@ -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: @@ -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: # categories: diff --git a/o3df/settings.yml b/o3df/settings.yml index 917c86a..a2c7274 100644 --- a/o3df/settings.yml +++ b/o3df/settings.yml @@ -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: @@ -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: # categories: diff --git a/omp/settings.yml b/omp/settings.yml index d4747b7..963c06c 100644 --- a/omp/settings.yml +++ b/omp/settings.yml @@ -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: @@ -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: # categories: diff --git a/openssf/settings.yml b/openssf/settings.yml index ded9bc9..764568d 100644 --- a/openssf/settings.yml +++ b/openssf/settings.yml @@ -47,9 +47,14 @@ url: https://openssf.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: @@ -182,6 +187,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: # categories: diff --git a/ospo/settings.yml b/ospo/settings.yml index ce82fd8..4af8228 100644 --- a/ospo/settings.yml +++ b/ospo/settings.yml @@ -47,9 +47,14 @@ url: https://ospo.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: @@ -175,6 +180,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: # categories: diff --git a/overturemaps/settings.yml b/overturemaps/settings.yml index 84a6165..f04a4c7 100644 --- a/overturemaps/settings.yml +++ b/overturemaps/settings.yml @@ -47,9 +47,14 @@ url: https://overturemaps.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: @@ -178,6 +183,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: # categories: diff --git a/pqca/settings.yml b/pqca/settings.yml index e211bdb..5fefa31 100644 --- a/pqca/settings.yml +++ b/pqca/settings.yml @@ -47,9 +47,14 @@ url: https://pqca.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: @@ -177,6 +182,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: # categories: diff --git a/presto/settings.yml b/presto/settings.yml index 4480726..8ffe055 100644 --- a/presto/settings.yml +++ b/presto/settings.yml @@ -47,9 +47,14 @@ url: https://presto.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: @@ -168,6 +173,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: # categories: diff --git a/riscv/settings.yml b/riscv/settings.yml index 47eb0ff..0d67f42 100644 --- a/riscv/settings.yml +++ b/riscv/settings.yml @@ -47,9 +47,14 @@ url: https://riscv.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: @@ -187,6 +192,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: # categories: diff --git a/spdx/settings.yml b/spdx/settings.yml index 4df1568..9f6ebf0 100644 --- a/spdx/settings.yml +++ b/spdx/settings.yml @@ -47,9 +47,14 @@ url: https://spdx.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: @@ -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: # categories: