diff --git a/README.md b/README.md index fdbfe0ff6..69a1ac7c7 100644 --- a/README.md +++ b/README.md @@ -1 +1,12 @@ # falco-website + +## Translation + +There is currently scaffolding in place for a Chinese translation of the site. To develop the translation, run `make serve`. This will start the Hugo server running locally. Navigate to `http://localhost:1313/zh` to see the current Chinese translation. + +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`](./config.yaml) configuration file and translate those items from the current English. +1. See [`i18n/zh.yaml`](./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. diff --git a/config.yaml b/config.yaml index 16b7f68f9..79aa9408e 100644 --- a/config.yaml +++ b/config.yaml @@ -1,10 +1,151 @@ baseURL: / languageCode: en-us -title: Falco - Container Native Runtime Security theme: falco-fresh disableKinds: ["taxonomy", "taxonomyTerm"] pygmentsCodefences: true pygmentsStyle: monokai +defaultContentLanguage: en +disableLanguages: [zh] + +languages: + en: + title: Falco — Container-native Runtime Security + contentDir: content/en + params: + heroText: + # Main hero title + title: Container Native Runtime Security + # Hero subtitle (optional) + subtitle: Falco is an open source project for intrusion and abnormality detection for Cloud Native platforms such as Kubernetes, Mesosphere, and Cloud Foundry. Detect abnormal application behavior. Alert via Slack, Fluentd, NATS, and more. Protect your platform by taking action through serverless (FaaS) frameworks, or other automation. + # Button text + buttontext: Get started + sectionAbout: + title: About Falco. + summary: With more responsibility shifting left to developers and the opaque nature of containers, organizations require deeper insight into container activities. The Falco project was hatched to understand container behavior and protect your platform from possible malicious activity. Leveraging Sysdig’s open source Linux kernel instrumentation, Falco gains deep insight into system behavior. The rules engine can then detect abnormal activity in applications, containers, the underlying host, and the container platform. + section1: + title: Key Features. + subtitle: + tiles: + - title: Platform Aware + icon: check.png + text: Build rules specific to your Cloud Native platforms to enforce policy across all your containers & microservices. + - title: Container-native + icon: box.png + text: Runtime Security built for containers. Built from the ground up to natively support containerized applications. + - title: Deep Visibility + icon: scalable.png + text: Complete container visibility through a single sensor. Gain insight into application and container behavior. + section2: + title: Downloads + Resources. + subtitle: Get started today, contribute to the open source project, & learn more. + resources: + - title: Contribute + text: Jump over to our GitHub page to contribute to our open source ecosystem. + # Icon (from /images/illustrations/icons/___.svg) + icon: group.png + buttonText: Falco Github + buttonLink: https://github.com/falcosecurity/falco + - title: Download + text: Get started with our Falco installation guide. + icon: download.png + buttonText: Falco Install Guide + buttonLink: /docs/installation + - title: Documentation + text: In the official docs, you can find information about [installing Falco](/docs/installation), [configuration options](/docs/configuration), and writing [custom rules](/docs/rules). + icon: documentation-2.png + buttonText: /docs + buttonLink: /docs + - title: Connect + text: Join our Slack team to interact with other users and developers. + icon: chat.png + buttonText: Falco Slack + buttonLink: https://slack.sysdig.com + section3: + title: Stay up to date. + subtitle: Sign-up for project updates. + buttonText: Sign-up! + menu: + navbar: + - name: About + url: "/#about" + weight: 1 + - name: Features + url: "/#features" + weight: 2 + - name: Download + url: "/#download" + - name: Docs + url: /docs + weight: 3 + zh: + title: Falco — Container-native Runtime Security + contentDir: content/zh + params: + heroText: + # Main hero title + title: Container Native Runtime Security + # Hero subtitle (optional) + subtitle: Falco is an open source project for intrusion and abnormality detection for Cloud Native platforms such as Kubernetes, Mesosphere, and Cloud Foundry. Detect abnormal application behavior. Alert via Slack, Fluentd, NATS, and more. Protect your platform by taking action through serverless (FaaS) frameworks, or other automation. + # Button text + buttontext: Get started + sectionAbout: + title: About Falco. (in chinese!) + summary: With more responsibility shifting left to developers and the opaque nature of containers, organizations require deeper insight into container activities. The Falco project was hatched to understand container behavior and protect your platform from possible malicious activity. Leveraging Sysdig’s open source Linux kernel instrumentation, Falco gains deep insight into system behavior. The rules engine can then detect abnormal activity in applications, containers, the underlying host, and the container platform. + section1: + title: Key Features. + subtitle: + tiles: + - title: Platform Aware + icon: check.png + text: Build rules specific to your Cloud Native platforms to enforce policy across all your containers & microservices. + - title: Container-native + icon: box.png + text: Runtime Security built for containers. Built from the ground up to natively support containerized applications. + - title: Deep Visibility + icon: scalable.png + text: Complete container visibility through a single sensor. Gain insight into application and container behavior. + section2: + title: Downloads + Resources. + subtitle: Get started today, contribute to the open source project, & learn more. + resources: + - title: Contribute + text: Jump over to our GitHub page to contribute to our open source ecosystem. + # Icon (from /images/illustrations/icons/___.svg) + icon: group.png + buttonText: Falco Github + buttonLink: https://github.com/falcosecurity/falco + - title: Download + text: Get started with our Falco installation guide. + icon: download.png + buttonText: Falco Install Guide + buttonLink: /docs/installation + - title: Documentation + text: In the official docs, you can find information about [installing Falco](/docs/installation), [configuration options](/docs/configuration), and writing [custom rules](/docs/rules). + icon: documentation-2.png + buttonText: /docs + buttonLink: /docs + - title: Connect + text: Join our Slack team to interact with other users and developers. + icon: chat.png + buttonText: Falco Slack + buttonLink: https://slack.sysdig.com + section3: + title: Stay up to date. + subtitle: Sign-up for project updates. + buttonText: Sign-up! + menu: + navbar: + - name: About + url: "/#about" + weight: 1 + - name: Features + url: "/#features" + weight: 2 + - name: Download + url: "/#download" + - name: Docs + url: /docs + weight: 3 params: version: v0.16.0 @@ -15,12 +156,6 @@ params: secondaryFont: name: "MaaxMono" hero: - # Main hero title - title: Container Native Runtime Security - # Hero subtitle (optional) - subtitle: Falco is an open source project for intrusion and abnormality detection for Cloud Native platforms such as Kubernetes, Mesosphere, and Cloud Foundry. Detect abnormal application behavior. Alert via Slack, Fluentd, NATS, and more. Protect your platform by taking action through serverless (FaaS) frameworks, or other automation. - # Button text - buttontext: Get started # Where the main hero button links to buttonlink: "#download" # Hero image (from /images/___) @@ -51,58 +186,4 @@ params: logo: cncf-black.svg cncfLink: https://cncf.io level: Sandbox - levelLink: https://github.com/cncf/toc/blob/master/process/sandbox.md - menu: - - title: About - url: "/#about" - - title: Features - url: "/#features" - - title: Download - url: "/#download" - - title: Docs - url: /docs - sectionAbout: - title: About Falco. - summary: With more responsibility shifting left to developers and the opaque nature of containers, organizations require deeper insight into container activities. The Falco project was hatched to understand container behavior and protect your platform from possible malicious activity. Leveraging Sysdig’s open source Linux kernel instrumentation, Falco gains deep insight into system behavior. The rules engine can then detect abnormal activity in applications, containers, the underlying host, and the container platform. - section1: - title: Key Features. - subtitle: - tiles: - - title: Platform Aware - icon: check.png - text: Build rules specific to your Cloud Native platforms to enforce policy across all your containers & microservices. - - title: Container-native - icon: box.png - text: Runtime Security built for containers. Built from the ground up to natively support containerized applications. - - title: Deep Visibility - icon: scalable.png - text: Complete container visibility through a single sensor. Gain insight into application and container behavior. - section2: - title: Downloads + Resources. - subtitle: Get started today, contribute to the open source project, & learn more. - resources: - - title: Contribute - text: Jump over to our GitHub page to contribute to our open source ecosystem. - # Icon (from /images/illustrations/icons/___.svg) - icon: group.png - buttonText: Falco Github - buttonLink: https://github.com/falcosecurity/falco - - title: Download - text: Get started with our Falco installation guide. - icon: download.png - buttonText: Falco Install Guide - buttonLink: /docs/installation - - title: Documentation - text: In the official docs, you can find information about [installing Falco](/docs/installation), [configuration options](/docs/configuration), and writing [custom rules](/docs/rules). - icon: documentation-2.png - buttonText: /docs - buttonLink: /docs - - title: Connect - text: Join our Slack team to interact with other users and developers. - icon: chat.png - buttonText: Falco Slack - buttonLink: https://slack.sysdig.com - section3: - title: Stay up to date. - subtitle: Sign-up for project updates. - buttonText: Sign-up! + levelLink: https://github.com/cncf/toc/blob/master/process/sandbox.md diff --git a/content/docs/_index.md b/content/en/docs/_index.md similarity index 100% rename from content/docs/_index.md rename to content/en/docs/_index.md diff --git a/content/docs/alerts/_index.md b/content/en/docs/alerts/_index.md similarity index 100% rename from content/docs/alerts/_index.md rename to content/en/docs/alerts/_index.md diff --git a/content/docs/alerts/formatting.md b/content/en/docs/alerts/formatting.md similarity index 100% rename from content/docs/alerts/formatting.md rename to content/en/docs/alerts/formatting.md diff --git a/content/docs/configuration.md b/content/en/docs/configuration.md similarity index 100% rename from content/docs/configuration.md rename to content/en/docs/configuration.md diff --git a/content/docs/event-sources/_index.md b/content/en/docs/event-sources/_index.md similarity index 100% rename from content/docs/event-sources/_index.md rename to content/en/docs/event-sources/_index.md diff --git a/content/docs/event-sources/dropped-events.md b/content/en/docs/event-sources/dropped-events.md similarity index 100% rename from content/docs/event-sources/dropped-events.md rename to content/en/docs/event-sources/dropped-events.md diff --git a/content/docs/event-sources/kernel-module.md b/content/en/docs/event-sources/kernel-module.md similarity index 100% rename from content/docs/event-sources/kernel-module.md rename to content/en/docs/event-sources/kernel-module.md diff --git a/content/docs/event-sources/kubernetes-audit.md b/content/en/docs/event-sources/kubernetes-audit.md similarity index 100% rename from content/docs/event-sources/kubernetes-audit.md rename to content/en/docs/event-sources/kubernetes-audit.md diff --git a/content/docs/event-sources/sample-events.md b/content/en/docs/event-sources/sample-events.md similarity index 100% rename from content/docs/event-sources/sample-events.md rename to content/en/docs/event-sources/sample-events.md diff --git a/content/docs/examples.md b/content/en/docs/examples.md similarity index 100% rename from content/docs/examples.md rename to content/en/docs/examples.md diff --git a/content/docs/installation.md b/content/en/docs/installation.md similarity index 100% rename from content/docs/installation.md rename to content/en/docs/installation.md diff --git a/content/docs/rules/_index.md b/content/en/docs/rules/_index.md similarity index 100% rename from content/docs/rules/_index.md rename to content/en/docs/rules/_index.md diff --git a/content/docs/rules/default-custom.md b/content/en/docs/rules/default-custom.md similarity index 100% rename from content/docs/rules/default-custom.md rename to content/en/docs/rules/default-custom.md diff --git a/content/docs/rules/default-macros.md b/content/en/docs/rules/default-macros.md similarity index 100% rename from content/docs/rules/default-macros.md rename to content/en/docs/rules/default-macros.md diff --git a/content/docs/rules/supported-fields.md b/content/en/docs/rules/supported-fields.md similarity index 100% rename from content/docs/rules/supported-fields.md rename to content/en/docs/rules/supported-fields.md diff --git a/content/docs/running.md b/content/en/docs/running.md similarity index 100% rename from content/docs/running.md rename to content/en/docs/running.md diff --git a/content/docs/source.md b/content/en/docs/source.md similarity index 100% rename from content/docs/source.md rename to content/en/docs/source.md diff --git a/content/zh/docs/_index.md b/content/zh/docs/_index.md new file mode 100644 index 000000000..970247298 --- /dev/null +++ b/content/zh/docs/_index.md @@ -0,0 +1,3 @@ +--- +title: Falco Chinese documentation +--- diff --git a/i18n/en.yaml b/i18n/en.yaml new file mode 100644 index 000000000..0e8fa8383 --- /dev/null +++ b/i18n/en.yaml @@ -0,0 +1,6 @@ +integrations_and_platforms: + other: Integrations & Platforms +copyright: + other: Copyright +falco_authors: + other: The Falco authors diff --git a/i18n/zh.yaml b/i18n/zh.yaml new file mode 100644 index 000000000..0e8fa8383 --- /dev/null +++ b/i18n/zh.yaml @@ -0,0 +1,6 @@ +integrations_and_platforms: + other: Integrations & Platforms +copyright: + other: Copyright +falco_authors: + other: The Falco authors diff --git a/layouts/.gitkeep b/layouts/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/themes/falco-fresh/layouts/partials/footer.html b/themes/falco-fresh/layouts/partials/footer.html index 8f7179f76..c0332fd9b 100644 --- a/themes/falco-fresh/layouts/partials/footer.html +++ b/themes/falco-fresh/layouts/partials/footer.html @@ -4,7 +4,7 @@ {{ if $isHome }}
{{ end }}
- Copyright {{ $year }}, The Falco authors + {{ T "copyright"}} {{ $year }}, {{ T "falco_authors"}}
{{ if $isHome }}
{{ end }} diff --git a/themes/falco-fresh/layouts/partials/hero-body.html b/themes/falco-fresh/layouts/partials/hero-body.html index 9b8dfe3a9..c860c5e85 100644 --- a/themes/falco-fresh/layouts/partials/hero-body.html +++ b/themes/falco-fresh/layouts/partials/hero-body.html @@ -1,9 +1,10 @@ {{- $hero := .Site.Params.hero }} -{{- $title := index $hero "title" }} -{{- $subtitle := index $hero "subtitle" }} -{{- $buttonText := index $hero "buttontext" }} -{{- $buttonLink := index $hero "buttonlink" }} -{{- $image := index $hero "image" }} +{{- $heroText := .Site.Params.heroText }} +{{- $title := $heroText.title }} +{{- $subtitle := $heroText.subtitle }} +{{- $buttonText := $heroText.buttontext }} +{{- $buttonLink := $hero.buttonlink }} +{{- $image := $hero.image }}
@@ -41,4 +42,4 @@

- \ No newline at end of file + diff --git a/themes/falco-fresh/layouts/partials/hero-footer.html b/themes/falco-fresh/layouts/partials/hero-footer.html index 4a1326c6e..ecdea7fb5 100644 --- a/themes/falco-fresh/layouts/partials/hero-footer.html +++ b/themes/falco-fresh/layouts/partials/hero-footer.html @@ -3,7 +3,7 @@
-

Integrations & Platforms

+

{{ T "integrations_and_platforms" }}

-
\ No newline at end of file + diff --git a/themes/falco-fresh/layouts/partials/navbar.html b/themes/falco-fresh/layouts/partials/navbar.html index d3c5be84f..2207faa52 100644 --- a/themes/falco-fresh/layouts/partials/navbar.html +++ b/themes/falco-fresh/layouts/partials/navbar.html @@ -1,12 +1,13 @@ -{{- $navbar := .Site.Params.navbar }} -{{- $menu := index $navbar "menu"}} -{{- $cncf := index $navbar "cncf" }} -{{- $isHome := .IsHome }} -{{- $isDocs := eq .Section "docs" }} +{{- $navbar := .Site.Params.navbar }} +{{- $menu := .Site.Menus.navbar }} +{{- $cncf := index $navbar "cncf" }} +{{- $isHome := .IsHome }} +{{- $isDocs := eq .Section "docs" }} +{{- $baseUrl := printf "/%s" .Language }}