Copyedits and fix X (Twitter) handle (#19)

- "Openclarity" --> "OpenClarity" - "open-source" --> "open source" - "cloud-native" --> "cloud native" - Update X (Twitter) handle to `OutshiftbyCisco` Co-authored-by: Jason DeTiberus <detiber@users.noreply.github.com>
openclarity · Nov 5, 2023 · c38b831 · c38b831
1 parent f04ba62
commit c38b831
Show file tree

Hide file tree

Showing 12 changed files with 39 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![Netlify Status](https://api.netlify.com/api/v1/badges/59e14813-c990-41a0-8662-45c204e6bc6b/deploy-status)](https://app.netlify.com/sites/hugo-openclarity/deploys)
 
-Openclarity documentation portal based on Hugo and Docsy
+OpenClarity documentation portal based on Hugo and Docsy
 
 [Docsy][] is a [Hugo theme module][] for technical documentation sites, providing easy
 site navigation, structure, and more. This **Docsy Example Project** uses the Docsy

diff --git a/config/_default/config.toml b/config/_default/config.toml
@@ -1,5 +1,5 @@
 baseURL = "/"
-title = "Openclarity"
+title = "OpenClarity"
 
 # Language settings
 languageCode = "en-us"
@@ -40,8 +40,8 @@ languageName ="English"
 # Weight used for sorting.
 weight = 1
 [languages.en.params]
-title = "Openclarity"
-description = "Openclarity is a suite of open source tools for cloud native security and observability — VM Security, Kubernetes Security, and API Security."
+title = "OpenClarity"
+description = "OpenClarity is a suite of open source tools for cloud native security and observability — VM Security, Kubernetes Security, and API Security."
 
 [outputs]
     home = ["HTML", "print"]
@@ -50,7 +50,7 @@ description = "Openclarity is a suite of open source tools for cloud native secu
 
 [social]
 # Used as twitter:site in page metadata
-twitter = "ciscoemerge"
+twitter = "outshiftbycisco"
 
 [markup]
   [markup.goldmark]
@@ -66,13 +66,13 @@ twitter = "ciscoemerge"
 
   email = "mailto:place@holder.io"
 
-  copyright = "The Openclarity Authors"
+  copyright = "The OpenClarity Authors"
 
   relativeURLs = true
 
   # Add project name to the header
-  project_name = "Openclarity"
-  product_name = "Openclarity"
+  project_name = "OpenClarity"
+  product_name = "OpenClarity"
 
   latest_version = "0.5.0" # Used in some installation commands
   latest_operator_version = "0.5.0"
@@ -159,7 +159,7 @@ twitter = "ciscoemerge"
   #  desc = "Discussion and help from your fellow users"
   #[[params.links.user]]
   #  name ="Twitter"
-  #  url = "https://twitter.com/ciscoemerge"
+  #  url = "https://twitter.com/outshiftbycisco"
   #  icon = "fab fa-twitter"
   #  desc = "Follow us on Twitter to get the latest news!"
   #[[params.links.user]]
@@ -172,7 +172,7 @@ twitter = "ciscoemerge"
     name = "GitHub"
     url = "https://github.com/openclarity"
     icon = "fab fa-github"
-    desc = "Get involved with Openclarity development"
+    desc = "Get involved with OpenClarity development"
   [[params.links.developer]]
     name = "Slack"
     url = "https://outshift.slack.com/messages/vmclarity"

diff --git a/content/_index.md b/content/_index.md
@@ -1,15 +1,15 @@
 ---
-title: Openclarity
+title: OpenClarity
 ---
 
 {{< blocks/cover image_anchor="top" width="min" color="white" disable_overlay=true >}}
 <div class="bg-white p-5 hero-card col-12 col-sm-10 col-md-8 col-lg-6">
 
 <img class="py-4" src="/img/color-logo/logo.svg" width="50%"/>
 
-<h2 class="hero-header py-4">Openclarity is an open-source platform to enhance security and observability of cloud-native applications and infrastructure.</h2>
+<h2 class="hero-header py-4">OpenClarity is an open source platform to enhance security and observability of cloud native applications and infrastructure.</h2>
 
-<h3 class="hero-subtitle">Openclarity delivers:</h3>
+<h3 class="hero-subtitle">OpenClarity delivers:</h3>
 <ul>
 <li>Agent-less detection and managements of vulnerabilities, exploits, malware and misconfigurations for VMs and Container Images</li>
 <li>Capabilities for runtime scans of Kubernetes and CI/CD pipelines</li>
@@ -32,17 +32,17 @@ title: Openclarity
   {{% card %}}
   ![Comprehensive Security icon](/img/key-benefits/icon_protected_1@3x.svg) </br>
   <h3>Comprehensive Security</h3>
-  Holistic cloud-native threat detection, mitigation and security for VMs, containerized workloads and APIs across all layers of infrastructure
+  Holistic cloud native threat detection, mitigation and security for VMs, containerized workloads and APIs across all layers of infrastructure
   {{% /card %}}
   {{% card %}}
   ![Open Source and Customizable icon](/img/key-benefits/icon_service_provider_1@3x.svg) </br>
   <h3>Open Source and Customizable</h3>
-  Organizations can tailor the platform to meet their security and observability requirements. Being open source, Openclarity offers Freedom to innovate for the community.
+  Organizations can tailor the platform to meet their security and observability requirements. Being open source, OpenClarity offers Freedom to innovate for the community.
   {{% /card %}}
   {{% card %}}
   ![Alignment with Cloud Native Principles icon](/img/key-benefits/icon_cloud_applications_1@3x.svg) </br>
   <h3>Alignment with Cloud Native Principles</h3>
-  Openclarity supports modern application architectures, making it a natural fit for organizations embracing cloud native technology
+  OpenClarity supports modern application architectures, making it a natural fit for organizations embracing cloud native technology
   {{% /card %}}
 {{< /cardpane >}}
 {{< /blocks/section >}}

diff --git a/content/carousel/3-api.md b/content/carousel/3-api.md
@@ -3,7 +3,7 @@ title: API Security
 type: carousel
 ---
 
-<p class="carousel-text">Identify vulnerabilities with a comprehensive approach to capture API traffic, conduct security analyses, test API endpoints and uncover security issues in implementation. When OpenAPI specifications are unavailable, Openclarity offers their automatic reconstruction of based on observed API traffic.</p>
+<p class="carousel-text">Identify vulnerabilities with a comprehensive approach to capture API traffic, conduct security analyses, test API endpoints and uncover security issues in implementation. When OpenAPI specifications are unavailable, OpenClarity offers their automatic reconstruction of based on observed API traffic.</p>
 
 {{< cta-button text="Try it now" url="https://github.com/openclarity/apiclarity" classes="bg-sky-blue text-white" >}}
 

diff --git a/content/docs/contributing.md b/content/docs/contributing.md
@@ -5,7 +5,7 @@ weight: 5000
 
 ## How to Contribute
 
-Thanks for your interest in contributing to Openclarity! Here are a few general guidelines on contributing and
+Thanks for your interest in contributing to OpenClarity! Here are a few general guidelines on contributing and
 reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of
 the contributors managing and developing this open source project. In return, they should reciprocate that respect in
 addressing your issue, assessing changes, and helping you finalize your pull requests. In that spirit of mutual respect,
@@ -24,7 +24,7 @@ See the component-specific instructions:
 
 ## Reporting Issues
 
-Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through the issues list of the relevant component of Openclarity:
+Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through the issues list of the relevant component of OpenClarity:
 
 - [KubeClarity](https://github.com/openclarity/kubeclarity/issues)
 - [VMClarity](https://github.com/openclarity/vmclarity/issues)
@@ -36,7 +36,7 @@ possible, and, if possible, a test case.
 
 ## Development
 
-For details on developing or building Openclarity, see the detailed instructions of the individual components:
+For details on developing or building OpenClarity, see the detailed instructions of the individual components:
 
 - [KubeClarity]({{< relref "/docs/kubeclarity/development/_index.md" >}})
 - [VMClarity]({{< relref "/docs/vmclarity/development/_index.md" >}})
@@ -51,13 +51,13 @@ reserve breaking changes until the next major version release.
 
 ## Other Ways to Contribute
 
-We welcome anyone that wants to contribute to Openclarity to triage and reply to open issues to help troubleshoot
+We welcome anyone that wants to contribute to OpenClarity to triage and reply to open issues to help troubleshoot
 and fix existing bugs. Here is what you can do:
 
 - Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section,
   providing feedback to the issue's author on what might be missing.
-- Review and update the Openclarity documentation with up-to-date instructions and code samples.
-- Review existing pull requests, and testing patches against real existing applications that use Openclarity.
+- Review and update the OpenClarity documentation with up-to-date instructions and code samples.
+- Review existing pull requests, and testing patches against real existing applications that use OpenClarity.
 - Write a test, or add a missing test case to an existing test.
 
-Thanks again for your interest on contributing to Openclarity!
+Thanks again for your interest on contributing to OpenClarity!
diff --git a/content/docs/kubeclarity/_index.md b/content/docs/kubeclarity/_index.md
@@ -8,7 +8,7 @@ cascade:
 
 KubeClarity is a tool for detection and management of Software Bill Of Materials (SBOM) and vulnerabilities of container images and filesystems. It scans both runtime K8s clusters and CI/CD pipelines for enhanced software supply chain security.
 
-KubeClarity is the tool responsible for Kubernetes Security in the Openclarity platform.
+KubeClarity is the tool responsible for Kubernetes Security in the OpenClarity platform.
 
 ![KubeClarity dashboard screenshot](dashboard.png)
 

diff --git a/content/docs/kubeclarity/concepts/sbom/_index.md b/content/docs/kubeclarity/concepts/sbom/_index.md
@@ -6,17 +6,17 @@ weight: 100
 
 {{< include-headless "kubeclarity/intro-generate-sbom.md" >}}
 
-SBOMs are important because organizations increasingly rely on open-source and third-party software components to build and maintain their applications. These components can introduce security vulnerabilities and must be adequately managed and updated. SBOMs help you understand what open-source and third-party components are used in your applications, and identify and address any security vulnerabilities.
+SBOMs are important because organizations increasingly rely on open source and third-party software components to build and maintain their applications. These components can introduce security vulnerabilities and must be adequately managed and updated. SBOMs help you understand what open source and third-party components are used in your applications, and identify and address any security vulnerabilities.
 
-Under specific scenarios, generating and publishing SBOMs is mandatory for compliance with regulations and industry standards that require organizations to disclose the use of open-source and third-party software in their products.
+Under specific scenarios, generating and publishing SBOMs is mandatory for compliance with regulations and industry standards that require organizations to disclose the use of open source and third-party software in their products.
 
 ## SBOM standards
 
 There are several related standards, for example, CycloneDX, SPDX, SWID.
 
-[SPDX (Software Package Data Exchange)](https://spdx.dev/) is a standard format for communicating a software package’s components, licenses, and copyrights. It is commonly used to document the open-source components included in a proprietary software product. SPDX files can be easily read and understood by humans and machines, making it easy to track and manage open-source components in a software project. SPDX format is supported by Linux Foundation.
+[SPDX (Software Package Data Exchange)](https://spdx.dev/) is a standard format for communicating a software package’s components, licenses, and copyrights. It is commonly used to document the open source components included in a proprietary software product. SPDX files can be easily read and understood by humans and machines, making it easy to track and manage open source components in a software project. SPDX format is supported by Linux Foundation.
 
-CycloneDX is an open-source standard for creating software bill of materials files. It is like SPDX in that it documents the components and licenses associated with a software package, but it is specifically designed for use in software supply chain security. CycloneDX is a more lightweight format compared to SPDX, which is intended to be more detailed. CycloneDX format is supported by OWASP.
+CycloneDX is an open source standard for creating software bill of materials files. It is like SPDX in that it documents the components and licenses associated with a software package, but it is specifically designed for use in software supply chain security. CycloneDX is a more lightweight format compared to SPDX, which is intended to be more detailed. CycloneDX format is supported by OWASP.
 
 ## SBOM architecture
 
@@ -28,15 +28,15 @@ A typical SBOM architecture can be laid out as a tree-like dependency graph with
 
 ## SBOM generators
 
-There are two typical ways to generate SBOM: during the build process, or after the build and deployment using a Software Composition Analysis tool. Trivy and Syft are two noteworthy open-source generators among many other generators, including open-source and commercial. Both use CycloneDX format. It is also important to note that not all SBOMs can be generated equally. Each generator may pick up a few language libraries better than the others based on its implementation. It might take multiple runs through a few different types of generators to draw comprehensive insights.
+There are two typical ways to generate SBOM: during the build process, or after the build and deployment using a Software Composition Analysis tool. Trivy and Syft are two noteworthy open source generators among many other generators, including open source and commercial. Both use CycloneDX format. It is also important to note that not all SBOMs can be generated equally. Each generator may pick up a few language libraries better than the others based on its implementation. It might take multiple runs through a few different types of generators to draw comprehensive insights.
 
 {{< include-headless "kubeclarity/supported-sbom-generators.md" >}}
 
 ## Multiple SBOMs for accuracy
 
 KubeClarity can run multiple SBOM generators in parallel, and unify their results to generate a more accurate document.
 
-In such cases, KubeClarity compiles a merged SBOM from multiple open-source analyzers, and delivers a comprehensive SBOM document report. Although KubeClarity does not generate SBOMs, it integrates with popular generators so that a combined document can provide amplified inputs that can be further analyzed using vulnerability scanners. Leveraging multiple SBOM documents can improve visibility into software dependency posture.
+In such cases, KubeClarity compiles a merged SBOM from multiple open source analyzers, and delivers a comprehensive SBOM document report. Although KubeClarity does not generate SBOMs, it integrates with popular generators so that a combined document can provide amplified inputs that can be further analyzed using vulnerability scanners. Leveraging multiple SBOM documents can improve visibility into software dependency posture.
 
 KubeClarity formats the merged SBOM to comply with the input requirements of vulnerability scanners before starting vulnerability scans.
 

diff --git a/content/docs/security/security.md b/content/docs/security/security.md
@@ -4,13 +4,13 @@ weight: 8000
 ---
 
 This document outlines security procedures and general policies for the
-Openclarity project.
+OpenClarity project.
 
 ## Reporting a Bug
 
-The Openclarity team and community take all security bugs in
-Openclarity seriously. Thank you for improving the security of
-Openclarity. We appreciate your efforts and responsible disclosure and
+The OpenClarity team and community take all security bugs in
+OpenClarity seriously. Thank you for improving the security of
+OpenClarity. We appreciate your efforts and responsible disclosure and
 will make every effort to acknowledge your contributions.
 
 Report security bugs by emailing `oss-security@cisco.com`.

diff --git a/content/docs/vmclarity/_index.md b/content/docs/vmclarity/_index.md
@@ -10,7 +10,7 @@ cascade:
 
 VMClarity is an open source tool for agentless detection and management of Virtual Machine Software Bill Of Materials (SBOM) and security threats such as vulnerabilities, exploits, malware, rootkits, misconfigurations and leaked secrets.
 
-VMClarity is the tool responsible for VM Security in the Openclarity platform.
+VMClarity is the tool responsible for VM Security in the OpenClarity platform.
 
 <img src="/img/vmclarity_demo.gif" alt="VMClarity demo" />
 

diff --git a/layouts/partials/footer/left.html b/layouts/partials/footer/left.html
@@ -1,3 +1,3 @@
 <div class="col-6 col-sm-8 text-xs-center image-container order-sm-1">
-<img src="/img/footer-logos/OC_logo_H_1C_white.svg" alt="Openclarity logo" width="80%" />
+<img src="/img/footer-logos/OC_logo_H_1C_white.svg" alt="OpenClarity logo" width="80%" />
 </div>
diff --git a/layouts/partials/footer/right.html b/layouts/partials/footer/right.html
@@ -7,7 +7,7 @@
     </div>
 
     <div class="col-sm-6 col-md-6 col-xs-12 image-container">
-      <a href="https://twitter.com/ciscoemerge"><img src="/img/footer-logos/X Badge@3x.svg" /></a>
+      <a href="https://twitter.com/outshiftbycisco"><img src="/img/footer-logos/X Badge@3x.svg" /></a>
     </div>
 
   </div>

diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
   "description": "Example site that uses Docsy theme for technical documentation.",
   "repository": "github:openclarity/docs.openclarity.io",
   "homepage": "https://docs.openclarity.io",
-  "author": "Openclarity Authors",
+  "author": "OpenClarity Authors",
   "license": "Apache-2.0",
   "bugs": "https://github.com/openclarity/docs.openclarity.io/issues",
   "spelling": "cSpell:ignore HTMLTEST precheck postbuild -",