Skip to content

Commit

Permalink
Fixing all of the review comments (#179)
Browse files Browse the repository at this point in the history
  • Loading branch information
DanieldeR authored Sep 29, 2021
1 parent f42fd47 commit 53e2686
Show file tree
Hide file tree
Showing 15 changed files with 107 additions and 28 deletions.
2 changes: 1 addition & 1 deletion site/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ menu:
# - name: Update Images
# url: /docs/contributing/
params:
twitter_url: "https://twitter.com/"
twitter_url: "https://twitter.com/OssCartographer"
github_url: "https://github.com/vmware-tanzu/cartographer"
slack_url: "https://slack.com/"
github_base_url: "https://github.com/vmware-tanzu/cartographer"
Expand Down
6 changes: 3 additions & 3 deletions site/content/docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## TLDR

Cartographer is a Kubernetes native Supply Chain Choreographer. It allows App Operators to create pre-approved paths to production by integrating k8s resources with the elements of their existing toolchains (e.g. Jenkins).
Cartographer is a Supply Chain Choreographer for Kubernetes. It allows App Operators to create pre-approved paths to production by integrating k8s resources with the elements of their existing toolchains (e.g. Jenkins).

Each pre-approved supply chain creates a paved road to production; orchestrating supply chain components - test, build, scan, and deploy - allowing developers to be able to focus on delivering value to their users while also providing App Operators with the peace of mind that all code in production has passed through all of the steps of an approved workflow.

## Cartographer Design and Philosophy

Cartographer is a Kubernetes (K8s) native supply chain choreographer. In other words, Cartographer
Cartographer is a supply chain choreographer for Kubernetes. In other words, Cartographer
allows users to define all of the steps that an application must go through to create an image and Kubernetes configuration.
Users achieve this with the Supply Chain abstraction ([Spec Reference](reference.md#clustersupplychain)).

Expand All @@ -32,4 +32,4 @@ While the supply chain is operator facing, Cartographer also provides an abstrac

By design, supply chains can be reused by many workloads. This allows an operator to specify the steps in the path to production a single time, and for developers to specify their applications independently but for each to use the same path to production. The intent is that developers are able to focus on providing value for their users and can reach production quickly and easily, while providing peace of mind for app operators, who are ensured that each application has passed through the steps of the path to production that they’ve defined.

![Cartographer High Level Diagram](images/ownership-flow.png)
![Cartographer High Level Diagram](img/ownership-flow.png)
2 changes: 1 addition & 1 deletion site/content/docs/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ NAME READY STATUS RESTARTS AGE IP NODE
nginx 1/1 Running 0 13s 10.200.0.4 worker0
```

## Cartogrpaher word list
## Cartographer word list


A list of Cartographer-specific terms and words to be used consistently across the site.
Expand Down
6 changes: 3 additions & 3 deletions site/content/docs/v0.0.6/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## TLDR

Cartographer is a Kubernetes native Supply Chain Choreographer. It allows App Operators to create pre-approved paths to production by integrating k8s resources with the elements of their existing toolchains (e.g. Jenkins).
Cartographer is a Supply Chain Choreographer for Kubernetes. It allows App Operators to create pre-approved paths to production by integrating k8s resources with the elements of their existing toolchains (e.g. Jenkins).

Each pre-approved supply chain creates a paved road to production; orchestrating supply chain components - test, build, scan, and deploy - allowing developers to be able to focus on delivering value to their users while also providing App Operators with the peace of mind that all code in production has passed through all of the steps of an approved workflow.

## Cartographer Design and Philosophy

Cartographer is a Kubernetes (K8s) native supply chain choreographer. In other words, Cartographer
Cartographer is a supply chain choreographer for Kubernetes. In other words, Cartographer
allows users to define all of the steps that an application must go through to create an image and Kubernetes configuration.
Users achieve this with the Supply Chain abstraction ([Spec Reference](reference.md#clustersupplychain)).

Expand All @@ -32,4 +32,4 @@ While the supply chain is operator facing, Cartographer also provides an abstrac

By design, supply chains can be reused by many workloads. This allows an operator to specify the steps in the path to production a single time, and for developers to specify their applications independently but for each to use the same path to production. The intent is that developers are able to focus on providing value for their users and can reach production quickly and easily, while providing peace of mind for app operators, who are ensured that each application has passed through the steps of the path to production that they’ve defined.

![Cartographer High Level Diagram](images/ownership-flow.png)
![Cartographer High Level Diagram](img/ownership-flow.png)
Binary file added site/content/docs/v0.0.6/img/ownership-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion site/content/docs/v0.0.6/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ NAME READY STATUS RESTARTS AGE IP NODE
nginx 1/1 Running 0 13s 10.200.0.4 worker0
```

## Cartogrpaher word list
## Cartographer word list


A list of Cartographer-specific terms and words to be used consistently across the site.
Expand Down
3 changes: 3 additions & 0 deletions site/themes/template/assets/scss/_footer.scss
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ footer {
a {
vertical-align: middle;
}
img{
height: 50px;
}
}
.bottom-links {
margin: 10px 0px 30px 0px;
Expand Down
3 changes: 3 additions & 0 deletions site/themes/template/assets/scss/_header.scss
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ header {
.desktop-links {
padding-left: 0px;
}
.image{
height: 75px;
}
a {
color: $darkgrey;
font-family: $metropolis-light;
Expand Down
6 changes: 3 additions & 3 deletions site/themes/template/layouts/partials/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
<div class="wrapper footer-links">
<div class="top-links">
<ul class="left-links">
<!--<li><a href="{{ .Site.Params.twitter_url }}"><img src="/img/twitter.png" alt="Twitter logo" />Twitter</a></li>-->
<li><a href="{{ .Site.Params.twitter_url }}"><img src="/img/twitter.png" alt="Twitter logo" />Twitter</a></li>
<li><a href="{{ .Site.Params.github_url }}"><img src="/img/github.svg" alt="Github logo" />Github</a></li>
<!--<li><a href="{{ .Site.Params.slack_url }}"><img src="/img/slack.png" alt="Slack logo" /><span class="desktop">#Slack</span><span class="mobile">Slack</span></a></li>-->
</ul>
<div class="right-links">
<a href="/"> <img src="/img/vmware-logo.svg" alt="VMware logo" /></a>
<a href="/"> <img src="/img/cartographer-logo.svg" alt="VMware logo" /></a>
</div>
</div>
<div class="bottom-links">
<p class="copywrite">&copy; {{ now.Year }} Cartographer Authors. <a href="http://vmware.github.io/">A VMware-backed project. <img src="/img/vmware-logo.svg" alt="VMware logo" /></a></p>
<p class="copywrite">&copy; {{ now.Year }} Cartographer Authors. <a href="http://github.com/vmware-tanzu/">A VMware-backed project. <img src="/img/vmware-logo.svg" alt="VMware logo" /></a></p>
</div>
</div>
</footer>
6 changes: 3 additions & 3 deletions site/themes/template/layouts/partials/header.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{ $latest := (cond (.Site.Params.docs_versioning) .Site.Params.docs_latest "") }}
<header>
<div class="wrapper">
<a href="{{ .Site.BaseURL }}"><img class="image" src="/img/vmware-logo.svg" alt="Logo" /></a>
<a href="{{ .Site.BaseURL }}"><img class="image" src="/img/cartographer-logo.svg" alt="Logo" /></a>
<ul class="desktop-links">
<li><a href="/" {{ if (eq .RelPermalink "/") }}class="active"{{ end }}>Home</a></li>
<!--<li><a href="/plugins/" {{ if (eq .RelPermalink "/plugins/") }}class="active"{{ end }}>Plugins</a></li>-->
Expand All @@ -23,11 +23,11 @@
<!--<li><a href="/blog/" {{ if or (eq .Page.Section "posts") (eq .Page.Section "tags") }}class="active"{{ end }}>Blog</a></li>-->
<li><a href="/docs/{{ $latest }}" {{ if (eq .Page.Section "docs") }}class="active"{{ end }}>Documentation</a></li>
</ul>
<div class="social">
<!-- <div class="social">
<a href="#"><img src="/img/twitter.png" />Twitter</a>
<a href="#"><img src="/img/github.svg" />GitHub</a>
<a href="#"><img src="/img/slack.png" />Slack</a>
</div>
</div> -->
</div>
</div>
</header>
4 changes: 2 additions & 2 deletions site/themes/template/layouts/partials/hero.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<div class="hero homepage">
<div class="wrapper">
<div class="text-block">
<h1>Kubernetes Native Supply Chain Choreography</h1>
<p>Create reusable supply chains that define all of your application CI and CD in one place, on cluster.</p>
<h1>Easily Build Cloud Native Supply Chains</h1>
<p>Cartographer allows you to create secure and reusable supply chains that define all of your application CI and CD in one place, on cluster.</p>
<div class="buttons">
<a class="button" href="/docs/{{ $latest }}/">Learn More</a>
<a class="button secondary" href="https://www.github.com/vmware-tanzu/cartographer/releases/latest">Download Cartographer</a>
Expand Down
8 changes: 4 additions & 4 deletions site/themes/template/layouts/partials/homepage-grid.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<div class="grid three">
<div class="card">
<img src="/img/simple.svg" />
<h3>Re-Usable CI/CD</h3>
<p>Create templated Supply Chains that provide a path to production that can be used for any type of application</p>
<h3>Reusable CI/CD</h3>
<p>Create templated Supply Chains that provide a path to production for any type of application</p>
</div>
<div class="card">
<img src="/img/frictionless.svg" />
Expand All @@ -13,8 +13,8 @@ <h3>Separation of Concerns</h3>
</div>
<div class="card">
<img src="/img/seamless.svg" />
<h3>K8s Resource Interobability</h3>
<p>Choreograph K8s resources (as well as non-K8s resources) within a supply chain</p>
<h3>Kubernetes Resource Interoperability</h3>
<p>Choreograph Kubernetes resources (as well as non-Kubernetes resources) within a supply chain</p>
</div>
</div>
</div>
Expand Down
15 changes: 8 additions & 7 deletions site/themes/template/layouts/partials/use-cases.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,20 @@ <h2>Features</h2>
<img src="/img/administration.svg" />
</div>
<div class="col text">
<p class="strong">Create Re-Useable Supply Chains</p>
<p>Templating is built into the core of Cartographer - allowing the user to write K8s resource definitions once and re-use them in any supply chain. Supply chains are also templated by default and can be re-used for many types of applications.</p>
<p class="strong">Create Reuseable Supply Chains</p>
<p>Templating is built into the core of Cartographer - allowing the user to write Kubernetes resource definitions once and re-use them in any supply chain. Supply chains are also templated by default and can be re-used for many types of applications.</p>

<p>The end result is a minimum amount of yaml configuration necessary for platform teams and developers.</p>
<p>The end result is a minimum amount of YAML configuration necessary for platform teams and developers.</p>
<!--<p><a href="#" class="button tertiary">Duis aute</a></p>-->
</div>
</div>
<div class="grid two image-right">
<div class="col text">
<p class="strong">Defined Interface for Each Role</p>
<p>Supply chains are independent from workloads and define all and any of the steps that are necessary for an application to reach production - CI, integration & performance tests, Security (SAST & DAST), Compliance, etc... They're also cluster scoped allowing platform teams to add them to a cluster and for each development team to use the same supply chains.</p>
<p>Supply chains are independent of workloads and define all and any of the steps that are necessary for an application to reach production - CI, integration & performance tests, Security (SAST & DAST), Compliance, etc...</p>

<p>Updating supply chains on a cluster makes day 2 operations easy. Applying a new supply chain means that any team using it will get the updates as soon as they've been applied.</p>
<p>Updating supply chains on a cluster makes day 2 operations easy. Applying a new supply chain means that any team using it will get the updates as soon as they've been applied.
</p>

<p>Workloads provide an abstraction layer allowing developers to focus on their application and the application configuration parameters that they care about.</p>
<!--<p><a href="#" class="button tertiary">Duis aute</a></p>-->
Expand All @@ -32,9 +33,9 @@ <h2>Features</h2>
</div>
<div class="col text">
<p class="strong">Works with Existing Tools</p>
<p>Cartographer was designed to work with any K8s objects. As long as they are applied to a cluster they can be used in a supply chain. Cartographer allows you to wrap and template each of the objects that you would normally apply to a cluster and use them within a supply chain.</p>
<p>Cartographer was designed to work with any Kubernetes object. As long as they are applied to a cluster they can be used in a supply chain. Cartographer allows you to wrap and template each of the objects that you would normally apply to a cluster and use them within a supply chain.</p>

<p>The choreography engine lets a Cartographer user define sharp tools for each part of a path to production and allowing the tool to do what it was designed to do. When each tool completes, Cartographer passes any output from a previous tool to the next one in the supply chain.</p>
<p>The choreography engine lets a Cartographer user define sharp tools for each part of a path to production and allows the tool to do what it was designed to do. When each tool completes, Cartographer passes any output from a previous tool to the next one in the supply chain.</p>
<!--<p><a href="#" class="button tertiary">Duis aute</a></p>-->
</div>
</div>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 53e2686

Please sign in to comment.