Document landscape data file

README.md

@@ -27,7 +27,7 @@ You can check out how the generated landscapes look like by visiting the [CNCF l
 
 **Landscape2** is a CLI tool that generates static websites from the information available in the data sources provided. These data sources are passed to the tool via arguments, usually in the form of *urls* or *local paths*, and are as follows:
 
-- **Landscape data**. The landscape data file is a YAML file that describes the items that will be displayed in the landscape website. For backwards compatibility reasons, this file *must* follow the format and conventions defined in the [CNCF *landscape.yml* file](https://github.com/cncf/landscape/blob/master/landscape.yml).
+- **Landscape data**. The landscape data file is a YAML file that describes the items that will be displayed in the landscape website. For more information, please see the [reference documentation](https://github.com/cncf/landscape2/blob/main/docs/config/data.yml).
 
 - **Landscape settings**. The settings file is a YAML file that allows customizing some aspects of the generated landscape website, such as the logo, colors, how to group items or which ones should be featured. For more information about the settings file, please see the [reference documentation](https://github.com/cncf/landscape2/blob/main/docs/config/settings.yml).
 

crates/cli/src/new/template/data.yml

@@ -1,82 +1,74 @@
-landscape:
-  - category:
-    name: Category 1
+# Landscape2 data
+#
+# This file contains the data that will be used to generate the landscape.
+#
+# Reference documentation: https://github.com/cncf/landscape2/blob/main/docs/config/data.yml
+
+categories:
+  - name: Category 1
     subcategories:
-      - subcategory:
-        name: Subcategory 1-1
+      - name: Subcategory 1-1
         items:
-          - item:
+          - name: Item 1
             crunchbase: https://www.crunchbase.com/organization/cloud-native-computing-foundation
             description: This is the description of item 1
             homepage_url: https://cncf.io
             logo: cncf.svg
-            name: Item 1
             project: graduated
             repo_url: https://github.com/cncf/landscape2
             twitter: https://twitter.com/CloudNativeFdn
-          - item:
+          - name: Item 2
             crunchbase: https://www.crunchbase.com/organization/cloud-native-computing-foundation
             description: This is the description of item 2
             homepage_url: https://cncf.io
             logo: cncf.svg
-            name: Item 2
             project: sandbox
             repo_url: https://github.com/cncf/landscape2
             twitter: https://twitter.com/CloudNativeFdn
-          - item:
+          - name: Item 3
             description: This is the description of item 3
             homepage_url: https://cncf.io
             logo: cncf.svg
-            name: Item 3
-      - subcategory:
-        name: Subcategory 1-2
+      - name: Subcategory 1-2
         items:
-          - item:
+          - name: Item 4
             crunchbase: https://www.crunchbase.com/organization/cloud-native-computing-foundation
             description: This is the description of item 4
             homepage_url: https://cncf.io
             logo: cncf.svg
-            name: Item 4
             repo_url: https://github.com/cncf/landscape2
             twitter: https://twitter.com/CloudNativeFdn
-          - item:
+          - name: Item 5
             crunchbase: https://www.crunchbase.com/organization/cloud-native-computing-foundation
             description: This is the description of item 5
             homepage_url: https://cncf.io
             logo: cncf.svg
-            name: Item 5
             repo_url: https://github.com/cncf/landscape2
-  - category:
-    name: Category 2
+  - name: Category 2
     subcategories:
-      - subcategory:
-        name: Subcategory 2-1
+      - name: Subcategory 2-1
         items:
-          - item:
+          - name: Item 6
             crunchbase: https://www.crunchbase.com/organization/cloud-native-computing-foundation
             description: This is the description of item 6
             homepage_url: https://cncf.io
             logo: cncf.svg
-            name: Item 6
             project: graduated
             repo_url: https://github.com/cncf/landscape2
             twitter: https://twitter.com/CloudNativeFdn
-          - item:
+          - name: Item 7
             crunchbase: https://www.crunchbase.com/organization/cloud-native-computing-foundation
             description: This is the description of item 7
             homepage_url: https://cncf.io
             logo: cncf.svg
-            name: Item 7
             project: sandbox
             repo_url: https://github.com/cncf/landscape2
             twitter: https://twitter.com/CloudNativeFdn
-          - item:
+          - name: Item 8
             description: This is the description of item 8
             homepage_url: https://cncf.io
             logo: cncf.svg
-            name: Item 8
-      - subcategory:
-        name: Subcategory 2-2
+      - name: Subcategory 2-2
         items:
           - item:
             crunchbase: https://www.crunchbase.com/organization/cloud-native-computing-foundation

crates/cli/src/new/template/guide.yml

@@ -2,15 +2,7 @@
 #
 # This file allows defining the content of the landscape guide.
 #
-# The landscape guide is organized into categories and subcategories. Each of
-# these entities requires a name and some content. The content can be provided
-# in markdown format. Categories and subcategories names are not required to
-# match the ones defined in the landscape data file but, when they do, those
-# categories/subcategories will be enriched with some extra information. So
-# whenever possible, it's highly recommended that they do.
-#
-# We recommend using headings of level 4-6 within the content blocks as levels
-# 1-3 are reserved to illustrate the hierarchy of categories and subcategories.
+# Reference documentation: https://github.com/cncf/landscape2/blob/main/docs/config/guide.yml
 
 categories:
   - category: "Category 1"