Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README file (landscape v2 migration) #209

Merged
merged 1 commit into from
Apr 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 13 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,43 @@

![OSPO Landscape Logo](images/left-logo.svg)

This landscape is intended as a map to explore the OSPO Ecosystem, and also shows the member companies of the TODO Group. It is modelled after the Cloud Native Computing Foundation (CNCF) [landscape](https://landscape.cncf.io) and based on the same open source code.
This landscape is intended as a map to explore the OSPO Ecosystem, and also shows the member companies of the TODO Group. It is modelled after the Cloud Native Computing Foundation (CNCF) [landscape](https://landscape.cncf.io) and based on the same [open source code](https://github.com/cncf/landscape2).

## Current Version

[![OSPO Landscape](https://landscape.todogroup.org/images/landscape.png)](https://landscape.todogroup.org/images/landscape.png)
[![OSPO Landscape](images/landscape.png)](images/landscape.png)

## Interactive Version

Please see [landscape.todogroup.org](https://landscape.todogroup.org).

## New Entries

We welcome contributors who are willing to include new entries of organizations that have an OSPO (Open Source Program Office) or a similar open source initiative in the *OSPO Adopter* category, as well as open source projects that assist OSPOs in the *Tools* category.
We welcome contributors who are willing to include new entries of organizations that have an OSPO (Open Source Program Office) or a similar open source initiative in the *OSPO Adopter* category, as well as open source projects that assist OSPOs in the *Tools* category.

> An OSPO does NOT need to be a TODO Member to be in the OSPO Landscape as an OSPO Adopter, every organization with an OSPO (governments, companies, academic institutions) can apply.

To submit a new entry, please take note of the following guidelines:

* Organizations with an OSPO or open source initiative must have a public facing site (e.g., https://opensource.google, https://ospo.ucsc.edu/ or https://github.com/aiven)
* Organizations with an OSPO or open source initiative must have a public facing site (e.g., <https://opensource.google>, <https://ospo.ucsc.edu/> or <https://github.com/aiven>)
* Projects must be open source and hosted in a source code management system, like GitLab, GitHub, etc.
* The project or organization needs a logo and the logo needs to include the name.
* We are unlikely to create a new category for projects as we'd rather find the best home with the current options.

If you think your organization or project should be included, please open a pull request to add it to [landscape.yml](landscape.yml). For the logo, you can either upload an SVG to the `hosted_logos` directory or put a URL as the value, and it will be fetched.

Netlify will generate a staging server for you to preview your updates. Please check that the logo and information appear correctly and then add `LGTM` to the pull request confirming your review and requesting a merge.
If you think your organization or project should be included, please open a pull request to add it to [landscape.yml](landscape.yml). A logo must be added to the `hosted_logos` directory (in SVG format) and referenced from the `logo` field.

## Logos

The following rules will produce the most readable and attractive logos:

1. We require SVGs, as they are smaller, display correctly at any scale, and work on all modern browsers. If you only have the logo in another vector format (like AI or EPS), please open an issue and we'll convert it to an SVG for you, or you can often do it yourself at https://cloudconvert.com/. Note that you may need to zip your file to attach it to a GitHub issue. Please note that we require pure SVGs and will reject SVGs that contain embedded PNGs since they have the same problems of being bigger and not scaling seamlessly. We also require that SVGs convert fonts to outlines so that they will render correctly whether or not a font is installed. See [Proper SVGs](#proper-svgs) below.
1. When multiple variants exist, use stacked (not horizontal) logos. For example, we use the second column (stacked), not the first (horizontal), of CNCF project [logos](https://github.com/cncf/artwork/#cncf-incubating-logos).
1. Don't use reversed logos (i.e., with a non-white, non-transparent background color). If you only have a reversed logo, create an issue with it attached and we'll produce a non-reversed version for you.
1. Logos must include the company, product or project name in English. It's fine to also include words from another language. If you don't have a version of your logo with the name in it, please open an issue and we'll create one for you (and please specify the font).
1. Match the item name to the English words in the logos. So an Acme Rocket logo that shows "Rocket" should have product name "Rocket", while if the logo shows "Acme Rocket", the product name should be "Acme Rocket". Otherwise, logos looks out of place when you sort alphabetically.
1. Google images is often the best way to find a good version of the logo (but ensure it's the up-to-date version). Search for [grpc logo filetype:svg](https://www.google.com/search?q=grpc+logo&tbs=ift:svg,imgo:1&tbm=isch) but substitute your project or product name for grpc.
1. You can either upload an SVG to the `hosted_logos` directory or put a URL as the value, and it will be fetched.
1. We require SVGs, as they are smaller, display correctly at any scale, and work on all modern browsers.
2. When multiple variants exist, use stacked (not horizontal) logos. For example, we use the second column (stacked), not the first (horizontal), of CNCF project [logos](https://github.com/cncf/artwork/#cncf-incubating-logos).
3. Don't use reversed logos (i.e., with a non-white, non-transparent background color).
4. Logos must include the company, product or project name in English. It's fine to also include words from another language.
5. Match the item name to the English words in the logos. So an Acme Rocket logo that shows "Rocket" should have product name "Rocket", while if the logo shows "Acme Rocket", the product name should be "Acme Rocket". Otherwise, logos looks out of place when you sort alphabetically.
6. Google images is often the best way to find a good version of the logo (but ensure it's the up-to-date version). Search for [grpc logo filetype:svg](https://www.google.com/search?q=grpc+logo&tbs=ift:svg,imgo:1&tbm=isch) but substitute your project or product name for grpc.

## Proper SVGs
### Proper SVGs

SVGs need to not rely on external fonts so that they will render correctly in any web browser, whether or not the correct fonts are installed. If you have the original AI file, here are the steps in Illustrator to create a proper SVG:

Expand All @@ -55,48 +52,10 @@ SVGs need to not rely on external fonts so that they will render correctly in an

## Corrections

Please open a pull request with edits to [landscape.yml](landscape.yml).
Please open a pull request with edits to [landscape.yml](landscape.yml).

## License

This repository contains data received from [Crunchbase](http://www.crunchbase.com). This data is not licensed pursuant to the Apache License. It is subject to Crunchbase’s Data Access Terms, available at [https://data.crunchbase.com/v3.1/docs/terms](https://data.crunchbase.com/v3.1/docs/terms), and is only permitted to be used with this Landscape Project which is hosted by the Linux Foundation.

Everything else is under the Apache License, Version 2.0, except for project and product logos, which are generally copyrighted by the company that created them, and are simply cached here for reliability. The trail map, static landscape, serverless landscape, and [landscape.yml](landscape.yml) file are alternatively available under the [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/).

# Deprecated InstalationDoc (New doc TBD)

## Installation

You can install and run locally with the [install directions](INSTALL.md). It's not necessary to install locally if you just want to edit [landscape.yml](landscape.yml). You can do so via the GitHub web interface.

## Vulnerability reporting

Please open an [issue](https://github.com/cncf/landscape/issues/new) or, for sensitive information, email [email protected].

## Adjusting the Landscape View
The file src/components/MainContent2.js describes the key elements of a
landscape big picture. It specifies where to put these sections: App Definition
and Development, Orchesteration & Management, Runtime, Provisioning, Cloud,
Platform, Observability and Analyzis, Special. Also it specifies where to
locate the link to the serverless preview and an info with a QR code.

All these elements should have `top`, `left`, `width` and `height` properties to
position them. `rows` and `cols` specify how much columns or rows we expect in a
given horizontal or vertical section.

When we see that those elements can not fit the sections, we need to either increase
the width of all the horizontal sections, or increase height and amount of rows
in a single horitzontal section and adjust the position of sections below.

Beside that, we have to adjust the width of a parent div (1620), the width in a
`src/components/BigPicture/FullscreenLandscape.js` (1640) and the width in a
`tools/renderLandscape.js` (6560, because of x4 zoom and margins)

Sometimes the total height is changed too, then we need to adjust the height the
same way as we adjust the width.

We have an experimental `fitWidth` property, it is good when you want to get rid of
an extra space on the right of a section.

The best way to test that layout is ok, is to visit `/landscape`, and if it looks ok, run `PORT=3000 babel-node
tools/renderLandscape` and see the rendered png files, they are in src/images folder.
Binary file added images/landscape.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading