Merge pull request #48 from lucperkins/lperkins/zh-translation

Enable i18n translation
falcosecurity · Jul 24, 2019 · c4abefd · c4abefd
2 parents f2021e8 + 13ff378
commit c4abefd
Show file tree

Hide file tree

Showing 28 changed files with 191 additions and 82 deletions.
diff --git 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
@@ -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 → content/en/docs/_index.md b/content/docs/_index.md → content/en/docs/_index.md
diff --git a/content/docs/alerts/_index.md → content/en/docs/alerts/_index.md b/content/docs/alerts/_index.md → content/en/docs/alerts/_index.md
diff --git a/content/docs/alerts/formatting.md → content/en/docs/alerts/formatting.md b/content/docs/alerts/formatting.md → content/en/docs/alerts/formatting.md
diff --git a/content/docs/configuration.md → content/en/docs/configuration.md b/content/docs/configuration.md → content/en/docs/configuration.md
diff --git a/content/docs/event-sources/_index.md → content/en/docs/event-sources/_index.md b/content/docs/event-sources/_index.md → content/en/docs/event-sources/_index.md
diff --git a/content/docs/event-sources/dropped-events.md → ...t/en/docs/event-sources/dropped-events.md b/content/docs/event-sources/dropped-events.md → ...t/en/docs/event-sources/dropped-events.md
diff --git a/content/docs/event-sources/kernel-module.md → ...nt/en/docs/event-sources/kernel-module.md b/content/docs/event-sources/kernel-module.md → ...nt/en/docs/event-sources/kernel-module.md
diff --git a/...nt/docs/event-sources/kubernetes-audit.md → ...en/docs/event-sources/kubernetes-audit.md b/...nt/docs/event-sources/kubernetes-audit.md → ...en/docs/event-sources/kubernetes-audit.md
diff --git a/content/docs/event-sources/sample-events.md → ...nt/en/docs/event-sources/sample-events.md b/content/docs/event-sources/sample-events.md → ...nt/en/docs/event-sources/sample-events.md
diff --git a/content/docs/examples.md → content/en/docs/examples.md b/content/docs/examples.md → content/en/docs/examples.md
diff --git a/content/docs/installation.md → content/en/docs/installation.md b/content/docs/installation.md → content/en/docs/installation.md
diff --git a/content/docs/rules/_index.md → content/en/docs/rules/_index.md b/content/docs/rules/_index.md → content/en/docs/rules/_index.md
diff --git a/content/docs/rules/default-custom.md → content/en/docs/rules/default-custom.md b/content/docs/rules/default-custom.md → content/en/docs/rules/default-custom.md
diff --git a/content/docs/rules/default-macros.md → content/en/docs/rules/default-macros.md b/content/docs/rules/default-macros.md → content/en/docs/rules/default-macros.md
diff --git a/content/docs/rules/supported-fields.md → content/en/docs/rules/supported-fields.md b/content/docs/rules/supported-fields.md → content/en/docs/rules/supported-fields.md
diff --git a/content/docs/running.md → content/en/docs/running.md b/content/docs/running.md → content/en/docs/running.md
diff --git a/content/docs/source.md → content/en/docs/source.md b/content/docs/source.md → content/en/docs/source.md
diff --git a/content/zh/docs/_index.md b/content/zh/docs/_index.md
@@ -0,0 +1,3 @@
+---
+title: Falco Chinese documentation
+---
diff --git a/i18n/en.yaml 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
@@ -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
diff --git a/themes/falco-fresh/layouts/partials/footer.html b/themes/falco-fresh/layouts/partials/footer.html
@@ -4,7 +4,7 @@
   {{ if $isHome }}<div class="container">{{ end }}
     <div class="columns">
       <div class="column">
-        Copyright {{ $year }}, The Falco authors
+        {{ T "copyright"}} {{ $year }}, {{ T "falco_authors"}}
       </div>
     </div>
   {{ if $isHome }}</div>{{ end }}

diff --git 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 }}
 <div class="hero-body">
   <div class="container">
     <div class="columns u-logo-offset">
@@ -41,4 +42,4 @@ <h2 class="subtitle is-5 is-muted">
       </div>
     </div>
   </div>
-</div>
+</div>
diff --git a/themes/falco-fresh/layouts/partials/hero-footer.html b/themes/falco-fresh/layouts/partials/hero-footer.html
@@ -3,7 +3,7 @@
 <div class="hero-foot mb-20">
   <div class="container">
     <div class="title-wrapper has-text-centered">
-      <h3 class="subtitle is-3 is-muted">Integrations & Platforms</h3>
+      <h3 class="subtitle is-3 is-muted">{{ T "integrations_and_platforms" }}</h3>
     </div>
     <ul class="c-logo-grid">
       {{- range $clientLogos }}
@@ -13,4 +13,4 @@ <h3 class="subtitle is-3 is-muted">Integrations & Platforms</h3>
       {{- end }}
     </ul>
   </div>
-</div>
+</div>
diff --git 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 }}
 <nav class="navbar is-fixed-top" role="navigation" aria-label="main navigation">
   {{ if $isHome }}<div class="container">{{ end }}
     <div class="navbar-brand">
-      <a class="navbar-item{{ if $isDocs }} is-hidden-tablet{{ end }}" href="{{ "/" | absURL }}">
+      <a class="navbar-item{{ if $isDocs }} is-hidden-tablet{{ end }}" href="{{ $baseUrl }}">
         <img class="navbar-brand__logo" src="{{ "/images/logos/falco-logo.png" | absURL }}" alt="">
       </a>
 
@@ -20,8 +21,8 @@
     <div id="navbar-menu" class="navbar-menu is-static">
       <div class="navbar-end">
         {{ range $menu }}
-        <a class="navbar-item has-text-grey is-size-5" href="{{ .url }}">
-          {{ .title }}
+        <a class="navbar-item has-text-grey is-size-5" href="{{ .URL }}">
+          {{ .Name }}
         </a>
         {{ end }}
 

diff --git a/themes/falco-fresh/layouts/partials/section-about.html b/themes/falco-fresh/layouts/partials/section-about.html
@@ -1,6 +1,6 @@
 {{- $sectionAbout := .Site.Params.sectionAbout }}
-{{- $title    := index $sectionAbout "title" }}
-{{- $summary     := index $sectionAbout "summary" }}
+{{- $title        := $sectionAbout.title }}
+{{- $summary      := $sectionAbout.summary }}
 <a id="about"></a>
 <section class="section section-feature-grey">
   <div class="container">
@@ -16,4 +16,4 @@ <h2 class="title is-3 has-text-weight-normal">{{ $title }}</h2>
       </div>
     </div>
   </div>
-</section>
+</section>