leogr / falco-website

Hugo content to generate website content. Hosted by the CNCF

falco-website

Contributing logos

In order to contribute a logo you must meet one of the following adopter types.

• End-user, with a contribution to ADOPTERS.md
• Vendor, with a contribution to ADOPTERS.md
• Integration, with a contribution to the Falco contrib repository. This must be documentation at the very least that describes how to use Falco with your project or tool.

Then open a pull request to this repository that contains:

• A .png or .svg file in clients
• A change to config.yaml that includes your logo alphabetically
• Links and references to demonstrate you meet the criteria above.

We try not to duplicate logos, and would prefer more encompassing logos over granular logos. For instance we prefer AWS over AWS EC2.

Prerequisites

To build this website you need:

• Hugo
• Nodejs
• Yarn

Test locally

Clone repository

git clone [e-mail]:falcosecurity/falco-website.git

Run hugo server

make serve

You can access your local website on http://localhost:1313

Translations

Chinese

There is currently scaffolding in place for a Chinese translation of the site.

To translate docs into Chinese, create Chinese-language Markdown files in the content/zh/docs directory.

To translate other parts of the site:

1. See the languages.zh block in the site's config.yaml configuration file and translate those items from the current English.
2. See i18n/zh.yaml for a handful of language snippets that need to be translated from the current English. Translate the other block of each term.

Japanese

There is currently scaffolding in place for a Japanese translation of the site.

To translate docs into Japanese, create Japanese-language Markdown files in the content/jp/docs directory.

To translate other parts of the site:

1. See the languages.jp block in the site's config.yaml configuration file and translate those items from the current English.
2. See i18n/jp.yaml for a handful of language snippets that need to be translated from the current English. Translate the other block of each term.

Korean

There is currently scaffolding in place for a Korean translation of the site.

To translate docs into Korean, create Korean Markdown file(s) in the content/ko/docs directory.

To translate other parts of the site:

1. See the languages.ko block in the site's config.yaml configuration file and translate those items from the current English.
2. See i18n/ko.yaml for a handful of language snippets that need to be translated from the current English. Translate the other block of each term.