Sync settings.yml with landscapew2-sites

settings.yml

@@ -1,10 +1,77 @@
-foundation: Alliance for OpenUSD (AOUSD)
+# Landscape2 settings
+#
+# This settings file allows customizing some aspects of the landscape.
+
+# Foundation (required)
+#
+# Name of the foundation. This value is used in some labels, so we recommended
+# to keep it as short as possible.
+#
+# foundation: <FOUNDATION_NAME>
+#
+foundation: AOUSD
+
+# Url (required)
+#
+# Url where the landscape will be hosted.
+#
+# url: <LANDSCAPE_URL>
+#
 url: https://aousd.landscape2.io
 
+# Analytics (optional)
+#
+# Analytics providers configuration. When an analytics provider is set up, some
+# additional code from the provider will be injected into the web application.
+#
 analytics:
-  gtm:
-    container_id: GTM-5QC4L5QJ
+  gtm:                            # Google Tag Manager configuration
+    container_id: GTM-5QC4L5QJ  # Landscape web application container ID
+
+# Base path (optional)
+#
+# Base path where the landscape will be hosted. By default the generated
+# landscape is prepared to be hosted at the root of the domain. However, if the
+# landscape will be hosted in a subpath, this value must be set accordingly.
+#
+# base_path: /<BASE_PATH>
+#
+
+# Categories (optional)
+#
+# Categories information is read from the `landscape.yml` data file. The way
+# categories are displayed in the web application is computed dynamically based
+# on the number of categories and subcategories, as well as the number of items
+# on each. Sometimes, however, we may want subcategories to be displayed in a
+# 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.
+#
+# categories:
+#   - name: <CATEGORY_NAME>
+#     subcategories:
+#       - <SUBCATEGORY1_NAME>
+#       - <SUBCATEGORY2_NAME>
+#
 
+# Colors (optional)
+#
+# Colors used across the landscape UI. The colors section is optional but, when
+# provided, *all colors must be provided*. Colors must be specified using the
+# following format: "rgba(<RED>, <GREEN>, <BLUE>, <ALPHA>)".
+#
+# colors:
+#   color1: <COLOR1>  # Buttons, groups, links
+#   color2: <COLOR2>  # Some highlighted items like filters button, search icon
+#   color3: <COLOR3>  # Participation stats bars, spinners, modal titles
+#   color4: <COLOR4>  # Categories titles in filters, fieldset in filters modal
+#   color5: <COLOR5>  # Categories and subcategories frames (odd)
+#   color6: <COLOR6>  # Categories and subcategories frames (even)
+#   color7: <COLOR7>  # Borders, shadows and options boxes in games
+#
 colors:
   color1: rgba(32, 145, 208, 1)
   color2: rgba(5, 85, 182, 1)
@@ -14,6 +81,62 @@ colors:
   color6: rgba(52, 198, 243, 0.85)
   color7: rgba(232, 244, 250, 1)
 
+# End user (optional)
+#
+# This section allows defining what items should be marked as `end user` based
+# on the category and subcategory they belong to. If the `enduser` field has
+# been set on a given item, that value will take precedence.
+#
+# enduser:
+#   - category: <CATEGORY1>  (required)
+#     subcategories:         (optional)
+#       - <SUBCATEGORY1>
+#   - category: <CATEGORY2>
+#
+
+# Featured items (optional)
+#
+# This section allows highlighting items that match certain criteria. You can
+# define a list of rules and the matching items will be featured in a special
+# way in the landscape.
+#
+# Each rule must define a field for the check as well as the values that will
+# trigger a match. At the moment the fields supported are:
+#
+#   - maturity
+#   - subcategory
+#
+# When a given item's field matches any of the values provided, it will be
+# considered a featured item. For each option, it is possible to also define an
+# order (which item would be displayed first) and a label for the item.
+#
+# featured_items:
+#   - field: subcategory
+#     options:
+#       - value: <SUBCATEGORY1_NAME>
+#       - value: <SUBCATEGORY2_NAME>
+#
+
+# Footer (optional)
+#
+# This section allows customizing some aspects of the footer.
+#
+# footer:
+#   links:
+#     facebook: <FACEBOOK_URL>
+#     flickr: <FLICKR_URL>
+#     github: <GITHUB_URL>
+#     homepage: <HOMEPAGE_URL>
+#     instagram: <INSTAGRAM_URL>
+#     linkedin: <LINKEDIN_URL>
+#     slack: <SLACK_URL>
+#     twitch: <TWITCH_URL>
+#     twitter: <TWITTER_URL>
+#     wechat: <WECHAT_URL>
+#     youtube: <YOUTUBE_URL>
+#   logo: <LOGO_URL>  # Foundation logo featured on the footer
+#   text: <TEXT>      # Copyright notice, for example
+#
 footer:
   links:
     facebook: https://www.facebook.com/allianceopenusd
@@ -27,11 +150,125 @@ footer:
   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
+# landscape contains many items, it is recommended to use the `small` size.
+# However, if there aren't many items, choosing `medium` or `large` may make
+# the landscape look nicer. Users will still be able to adjust the items size
+# from the UI using the zoom controls.
+#
+# grid_items_size: <small|medium|large>
+#
 grid_items_size: large
 
+# Groups (optional)
+#
+# In some cases, especially when a landscape contains lots of items, it may be
+# interesting to organize them in groups. Each group will be displayed on a
+# different tab in the landscape web application. Each entry must contain the
+# 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.
+#
+# groups:
+#   - name: <GROUP_NAME>
+#     categories:
+#       - <CATEGORY1_NAME>
+#       - <CATEGORY2_NAME>
+#
+
+# Header (optional)
+#
+# This section allows customizing some aspects of the header.
+#
+# header:
+#   links:
+#     github: <GITHUB_URL>
+#   logo: <LOGO_URL>  # Foundation logo featured on the header
+#
 header:
   links:
     github: https://github.com/aousd/landscape
   logo: https://aousd.org/wp-content/uploads/sites/28/2023/07/logo-horizontal-color.svg
 
+# Images (optional)
+#
+# Urls of some images used in the landscape UI.
+#
+# images:
+#   favicon: <FAVICON_URL>
+#   open_graph: <OPEN_GRAPH_IMAGE_URL>
+#
+
+# Logos viewbox (optional)
+#
+# In order to display the logos as large as possible in the landscape, during
+# the build process we try to update their viewbox if `adjust` is set to true
+# (by default it is when this setting is not provided). However, sometimes this
+# does not help and logos may not be displayed correctly. In those cases, it is
+# possible to exclude some of them from being adjusted by adding the logo(s)
+# file name to the `exclude` list.
+#
+# logos_viewbox:
+#   adjust: true
+#   exclude:
+#     - logo1.svg
+#     - logo2.svg
+#
+
+# Name of the members category (optional)
+#
+# Landscapes usually have a special category dedicated to the members of the
+# corresponding foundation. It is possible to use any name for that category,
+# but it is important that we define it here as there are some special
+# operations that depend on it.
+#
+# members_category: <CATEGORY_NAME>
+#
+
+# Osano (optional)
+#
+# Osano cookies consent form configuration. When the Osano configuration is
+# provided, some additional code will be injected into the web application.
+#
+# The `customer_id` and `customer_configuration_id` fields values can be
+# obtained from the url in the configuration script code available on the Osano
+# site:
+#
+#   https://cmp.osano.com/<CUSTOMER_ID>/<CUSTOMER_CONFIGURATION_ID>/osano.js
+#
+# osano:
+#   customer_id: <CUSTOMER_ID>
+#   customer_configuration_id: <CUSTOMER_CONFIGURATION_ID>
+#
+
+# Screenshot width (optional)
+#
+# Width of the landscape screenshots automatically generated (in pixels).
+# Screenshots won't be taken if this value is not provided.
+#
+# screenshot_width: <WIDTH_IN_PIXELS>
+#
 screenshot_width: 1500
+
+# Upcoming event (optional)
+#
+# This section allows configuring an upcoming event that will be featured on
+# the landscape web application. Expired events won't be displayed.
+#
+# upcoming_event:
+#   name: <NAME>         # Event name (required)
+#   start: <START_DATE>  # Start date: (required, format: YYYY-MM-DD)
+#   end: <END_DATE>      # End date: (required, format: YYYY-MM-DD)
+#   banner_url: <URL>    # Event banner image url (required, recommended dimensions: 2400x300)
+#   details_url: <URL>   # Event details URL (required)
+#
+
+# View mode (optional)
+#
+# This section allows customizing the default view mode of the landscape web
+# application. The view mode can be set to either `grid` or `card`. When
+# omitted, the default view mode is `grid`.
+#
+# view_mode: <grid|card>
+#