commit 4f6b9c86133c622c2457ab24a15a2b1889f662e0 Author: Julien Lengrand-Lambert Date: Mon Aug 11 13:53:19 2025 +0200 Create landscape diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c795b05 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..0121968 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# 1ES Landscape + +This repository contains a landscape visualization for the 1 Engineering System (1ES). It organizes projects, categories, and related data to provide an overview of the 1ES ecosystem. + +## Structure + +- `data.yml` — Main data source for categories, subcategories, and items. +- `settings.yml` — Configuration for appearance and grouping. +- `guide.yml` — Content for the landscape guide. +- `games.yml` — Data for interactive games and quizzes. +- `build/` — Generated assets and static site output. + +## Usage + +1. Edit the YAML files (`data.yml`, `settings.yml`, etc.) to update the landscape. +2. Build or serve the site using your preferred static site generator or build process. + +## Installing + +* Currently, using the `homebrew`install (`brew install cncf/landscape2/landscape2`). +* Probably have to look into using the container setup for production. + +## Commands + +### Seeding a new landscape (Not needed for 1ES) + +```bash +$ landscape2 new --output-dir . +``` + +### Building + +```bash +$ landscape2 build + --data-file data.yml \ + --settings-file settings.yml \ + --guide-file guide.yml \ + --logos-path logos \ + --output-dir build +``` + +### Serving + +```bash +$ landscape2 serve --landscape-dir build +``` + +### Validating + +```bash +$ landscape2 validate settings --settings-file settings.yml +$ landscape2 validate games --settings-file games.yml +$ landscape2 validate data --settings-file data.yml +$ landscape2 validate guide --settings-file guide.yml +``` + + +## Resources + +- [Landscape documentation](https://github.com/cncf/landscape2?tab=readme-ov-file) \ No newline at end of file diff --git a/data.yml b/data.yml new file mode 100644 index 0000000..fc3ed6a --- /dev/null +++ b/data.yml @@ -0,0 +1,81 @@ +# 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: + - name: Subcategory 1-1 + items: + - 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 + project: graduated + repo_url: https://github.com/cncf/landscape2 + twitter: https://twitter.com/CloudNativeFdn + - 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 + project: sandbox + repo_url: https://github.com/cncf/landscape2 + twitter: https://twitter.com/CloudNativeFdn + - name: Item 3 + description: This is the description of item 3 + homepage_url: https://cncf.io + logo: cncf.svg + - name: Subcategory 1-2 + items: + - 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 + repo_url: https://github.com/cncf/landscape2 + twitter: https://twitter.com/CloudNativeFdn + - 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 + repo_url: https://github.com/cncf/landscape2 + - name: Category 2 + subcategories: + - name: Subcategory 2-1 + items: + - 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 + project: graduated + repo_url: https://github.com/cncf/landscape2 + twitter: https://twitter.com/CloudNativeFdn + - 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 + project: sandbox + repo_url: https://github.com/cncf/landscape2 + twitter: https://twitter.com/CloudNativeFdn + - name: Item 8 + description: This is the description of item 8 + homepage_url: https://cncf.io + logo: cncf.svg + - name: Subcategory 2-2 + items: + - item: + crunchbase: https://www.crunchbase.com/organization/cloud-native-computing-foundation + description: This is the description of item 9 + homepage_url: https://cncf.io + logo: cncf.svg + name: Item 9 + repo_url: https://github.com/cncf/landscape2 + twitter: https://twitter.com/CloudNativeFdn + diff --git a/games.yml b/games.yml new file mode 100644 index 0000000..4120ec9 --- /dev/null +++ b/games.yml @@ -0,0 +1,20 @@ +# Landscape2 games data +# +# This file contains the data that will be used in the landscape games. +# +# Reference documentation: https://github.com/cncf/landscape2/blob/main/docs/config/games.yml + +quiz: + questions: + - title: "Which of the following items have feature X?" + options: + - item: Item 1 + correct: true + - item: Item 2 + - item: Item 3 + - title: "Please select the item with feature Y" + options: + - item: Item 1 + - item: Item 2 + - item: Item 3 + correct: true diff --git a/guide.yml b/guide.yml new file mode 100644 index 0000000..3d394f0 --- /dev/null +++ b/guide.yml @@ -0,0 +1,32 @@ +# Landscape2 guide +# +# This file allows defining the content of the landscape guide. +# +# Reference documentation: https://github.com/cncf/landscape2/blob/main/docs/config/guide.yml + +categories: + - category: "Category 1" + content: | + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + subcategories: + - subcategory: "Subcategory 1-1" + content: | + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + - subcategory: "Subcategory 1-2" + content: | + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + - category: "Category 2" + content: | + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + subcategories: + - subcategory: "Subcategory 2-1" + content: | + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + - subcategory: "Subcategory 2-2" + content: | + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. diff --git a/logos/cncf.svg b/logos/cncf.svg new file mode 100644 index 0000000..0c001d5 --- /dev/null +++ b/logos/cncf.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/settings.yml b/settings.yml new file mode 100644 index 0000000..1fd45c8 --- /dev/null +++ b/settings.yml @@ -0,0 +1,58 @@ +# Landscape2 settings +# +# This settings file allows customizing some aspects of the landscape. +# +# Reference documentation: https://github.com/cncf/landscape2/blob/main/docs/config/settings.yml + +foundation: DEMO + +url: http://127.0.0.1:8000 + +colors: + color1: "rgba(0, 107, 204, 1)" + color2: "rgba(255, 0, 170, 1)" + color3: "rgba(96, 149, 214, 1)" + color4: "rgba(0, 42, 81, 0.7)" + color5: "rgba(1, 107, 204, 0.7)" + color6: "rgba(0, 42, 81, 0.7)" + color7: "rgba(180, 219, 255, 1)" + +featured_items: + - field: maturity + options: + - value: graduated + order: 1 + label: Graduated + +footer: + links: + facebook: "https://www.facebook.com/CloudNativeComputingFoundation/" + flickr: "https://www.flickr.com/photos/143247548@N03/albums" + github: "https://github.com/cncf" + homepage: "https://cncf.io" + instagram: "https://www.instagram.com/humans.of.cloudnative/" + linkedin: "https://www.linkedin.com/company/cloud-native-computing-foundation/" + slack: "https://slack.cncf.io/" + twitch: "https://www.twitch.tv/cloudnativefdn" + twitter: "https://twitter.com/cloudnativefdn" + wechat: "https://www.cncf.io/wechat/" + youtube: "https://www.youtube.com/c/cloudnativefdn" + logo: "https://raw.githubusercontent.com/cncf/artwork/master/other/cncf/horizontal/white/cncf-white.svg" + +grid_items_size: large + +groups: + - name: Some categories + categories: + - Category 1 + - Category 2 + - name: Only category 2 + categories: + - Category 2 + +header: + links: + github: "https://github.com/cncf/landscape2" + logo: "https://raw.githubusercontent.com/cncf/artwork/master/other/cncf-landscape/horizontal/color/cncf-landscape-horizontal-color.svg" + +screenshot_width: 1500