Skip to content

Commit

Permalink
docs(gh-pages/#3801): Remove unused folders and timeline. Add service…
Browse files Browse the repository at this point in the history
… offerings and logo. Change footer, design and landing page.
  • Loading branch information
christian-huehn-mw committed Oct 28, 2024
1 parent dfd662a commit b76173f
Show file tree
Hide file tree
Showing 29 changed files with 154 additions and 91 deletions.
17 changes: 5 additions & 12 deletions gh-pages/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# the others are Minimal Mistakes Configurations: https://mmistakes.github.io/minimal-mistakes/docs/configuration/

remote_theme: "mmistakes/minimal-mistakes"
minimal_mistakes_skin: "dark" # "default", "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"
minimal_mistakes_skin: "air" # "default", "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"

# Site Settings
locale: "en-US"
Expand All @@ -13,9 +13,9 @@ url: https://maibornwolff.github.io/ # the base hostname & protocol for your sit
baseurl: /codecharta # the subpath of your site, e.g. "/blog"
repository: MaibornWolff/codecharta # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
teaser: # path of fallback teaser image, e.g. "/assets/images/500x300.png"
logo: # path of logo image to display in the masthead, e.g. "/assets/images/88x88.png"
masthead_title: # overrides the website title displayed in the masthead, use " " for no title
# breadcrumbs : false # true, false (default)
logo: /assets/images/codecharta_logo.png # path of logo image to display in the masthead, e.g. "/assets/images/88x88.png"
masthead_title: CodeCharta # overrides the website title displayed in the masthead, use " " for no title
breadcrumbs: true
words_per_minute: 200

search: true
Expand All @@ -24,19 +24,12 @@ search_provider: lunr

social:
type: Organization # Person or Organization (defaults to Person)
name: # If the user or organization name differs from the site's name
name: MaibornWolff # If the user or organization name differs from the site's name
links: # An array of links to social media profiles

# Custom site variables, reference them in liquid like this: {{site.web_visualization_link}}
web_visualization_link: https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json.gz&file=codecharta_analysis.cc.json.gz&currentFilesAreSampleFiles=true

# Site Footer
footer:
links:
- label: "GitHub"
icon: "fab fa-fw fa-github"
url: https://github.com/MaibornWolff/codecharta

# Reading Files
include:
- .htaccess
Expand Down
15 changes: 9 additions & 6 deletions gh-pages/_data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
main:
- title: "Docs"
url: /docs/overview/
- title: "Showcase"
url: /showcase/
- title: "News"
url: /news/
- title: "Examples"
url: /examples/
- title: "Releases"
url: categories/#release
- title: "Service Offerings"
url: /docs/service-offerings/overview/

# docs navigation bar
docs:
Expand Down Expand Up @@ -94,5 +94,8 @@ docs:
url: /docs/feedback/
- title: "Price (Free)"
url: /docs/price/
- title: "Timeline"
url: /docs/timeline/

- title: Service Offerings
children:
- title: "Overview"
url: /docs/service-offerings/overview/
2 changes: 1 addition & 1 deletion gh-pages/_docs/01-02-quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ CodeCharta consists of two separate parts: [analysis]({{site.baseurl}}{% link _d

> Please note that CodeCharta runs only on your client. No `.cc.json` that you analyze or visualize will ever leave your computer unless you distribute it yourself.
You can [try the web visualization]({{site.web_visualization_link}}) immediately and explore CodeCharta Code in CodeCharta. No downloads necessary, though we do provide a [desktop client]({{site.baseurl}}{% link _docs/01-03-installation.md %}) for your convenience. The visualization interface is explained [here]({{site.baseurl}}{% link _docs/04-01-visualization.md %}) and if you want to explore another code base from the default one, you can use one of the files from the [showcase]({{site.baseurl}}{% link _pages/showcase.md %}).
You can [try the web visualization]({{site.web_visualization_link}}) immediately and explore CodeCharta Code in CodeCharta. No downloads necessary, though we do provide a [desktop client]({{site.baseurl}}{% link _docs/01-03-installation.md %}) for your convenience. The visualization interface is explained [here]({{site.baseurl}}{% link _docs/04-01-visualization.md %}) and if you want to explore another code base from the default one, you can use one of the files from the [showcase]({{site.baseurl}}{% link _pages/examples.md %}).

However, if you want to **generate your own** `.cc.json` files, you should read this guide first.

Expand Down
2 changes: 1 addition & 1 deletion gh-pages/_docs/05-04-price.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ title: "Price"

CodeCharta is free and licensed under MIT.

We initially created CodeCharta because we wanted a good tool for our [software audits](https://www.maibornwolff.de/software-audits). We were able to build it rather quickly because of all the great open source tools on the market so it made sense to also open source CodeCharta. Please use it as you see fit.
We initially created CodeCharta because we wanted a good tool for our [software health checks](https://www.maibornwolff.de/software-audits). We were able to build it rather quickly because of all the great open source tools on the market so it made sense to also open source CodeCharta. Please use it as you see fit.
34 changes: 0 additions & 34 deletions gh-pages/_docs/05-05-timeline.md

This file was deleted.

18 changes: 18 additions & 0 deletions gh-pages/_docs/06-01-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
permalink: /docs/service-offerings/overview
title: "Service offerings"
---

Your company has the dire need in understanding their code base and knowing how to move on? We at [MaibornWolff](https://www.maibornwolff.de/en) offer a lot of different services to help you with legacy and unmaintainable code.
We analyze your codebase and give you valuable insights in your code. Here are two popular services we offer:

# Code Quality Insights

Get a report about your hotspots and areas for improvement. This is currently free of charge.

<b>Click</b> the link to learn more: [Code Quality Insights](https://www.maibornwolff.de/en/code-quality-insights?utm_source=github&utm_medium_website&utm_campaign=code_charta_at_github&utm_id=code_charta_at_github)

# Software Health Check

A full Software Health Check for your codebase and everything around it.
<b>Click</b> the link to learn more: [Software Health Check](https://www.maibornwolff.de/software-audits)
81 changes: 81 additions & 0 deletions gh-pages/_includes/features.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<style>
.feature-row {
display: flex;
flex-wrap: wrap;
justify-content: center;
gap: 10px;
box-sizing: border-box;
}

.feature-item {
width: 400px;
display: flex;
flex-direction: column;
align-items: center;
text-align: center;
}

.feature-item h3 {
margin-top: 15px;
}

.feature-item p {
margin-top: 10px;
color: #555;
}

.image-container {
height: 300px;
}

.image-container img {
max-height: 300px;
}
</style>
<div class="feature-row">
<div class="feature-item">
<div class="image-container">
<img src="assets/images/features/visualize.png" alt="Interactive Visualization" />
</div>
<h3>Interactive Visualization</h3>
<p>
Turn your codebase into a dynamic, city-like map. Navigate through your code with ease and uncover insights you’ve never seen
before.
</p>
</div>

<div class="feature-item">
<div class="image-container">
<img src="assets/images/features/tangible.png" alt="Tangible Models" />
</div>
<h3>Tangible Models</h3>
<p>Bring your code to life! Print your codebase as a 3D model! Perfect for presentations.</p>
</div>

<div class="feature-item">
<div class="image-container">
<img src="assets/images/features/history.png" alt="Track your changes" />
</div>
<h3>Track your changes</h3>
<p>See how your codebase has grown ver time. Compare older maps to understand the impact your decisions had!</p>
</div>

<div class="feature-item">
<div class="image-container">
<img src="assets/images/features/imports.png" alt="Seamless Import" />
</div>
<h3>Seamless Import</h3>
<p>You can get metrics from a lot of different parsers and importers.</p>
</div>

<div class="feature-item">
<div class="image-container">
<img src="assets/images/features/cli.png" alt="Powerful CLI" />
</div>
<h3>Powerful CLI</h3>
<p>
Easily import metrics from a wide range of parsers and tools. Get a comprehensive view of your codebase without the hassle of
building it yourself.
</p>
</div>
</div>
27 changes: 27 additions & 0 deletions gh-pages/_includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<div class="page__footer-follow">
<ul class="social-icons">
<li>
<a href="https://github.com/MaibornWolff/codecharta" rel="nofollow noopener noreferrer">
<i class="fab fa-fw fa-github" aria-hidden="true"></i>
GitHub
</a>
</li>
<li>
<a href="/codecharta/feed.xml">
<i class="fas fa-fw fa-rss-square" aria-hidden="true"></i>
Feed
</a>
</li>
<li>
<a href="https://www.maibornwolff.de/en" rel="nofollow noopener noreferrer">
<img alt="MaibornWolff" src="{{site.baseurl}}/assets/images/mw_logo.png" class="fab fa-fw" />
MaibornWolff
</a>
</li>
</ul>
</div>
<div class="page__footer-copyright">
© 2024 <a href="https://maibornwolff.github.io/">CodeCharta</a> made with ♥ by
<a href="https://www.maibornwolff.de/en/">MaibornWolff</a>. Powered by <a href="https://jekyllrb.com" rel="nofollow">Jekyll</a> &amp;
<a href="https://mademistakes.com/work/jekyll-themes/minimal-mistakes/" rel="nofollow">Minimal Mistakes</a>.
</div>
5 changes: 0 additions & 5 deletions gh-pages/_includes/footer/custom.html

This file was deleted.

6 changes: 0 additions & 6 deletions gh-pages/_includes/head/custom.html

This file was deleted.

4 changes: 2 additions & 2 deletions gh-pages/_pages/showcase.md → gh-pages/_pages/examples.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Showcase"
permalink: /showcase/
title: "Examples"
permalink: /examples/

layout: collection
collection: showcase
Expand Down
34 changes: 10 additions & 24 deletions gh-pages/_pages/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,21 @@
layout: splash
permalink: /
header:
overlay_image: /assets/images/CC-Home.png
actions:
- label: "<i class='fas fa-fw fa-link'></i> Explore Web Studio"
url: "https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json.gz&file=codecharta_analysis.cc.json.gz&currentFilesAreSampleFiles=true"
- label: "<i class='fas fa-fw fa-link'></i> Quick Start"
url: "/docs/quick-start-guide/"
overlay_image: /assets/images/cc_home.png
overlay_filter: 0.3
excerpt: >
Combine and communicate code metrics. <br />
<small><a href="https://github.com/MaibornWolff/codecharta/releases/latest">Latest releases</a></small>
feature_row:
- title: "Combine any Metric"
excerpt: "Combine metrics from Sonar, Git, your source code and many more."
url: "/docs/analysis/"
btn_class: "btn--primary"
btn_label: "Learn more"
- title: "Add your own Metrics"
excerpt: "Metrics in Csv format can even be added without writing code."
url: "/docs/custom-metrics/"
btn_class: "btn--primary"
btn_label: "Learn more"
- title: "Big Picture"
excerpt: "Understand the big picture, then zoom in into hotspots."
url: "/docs/visualization/"
btn_class: "btn--primary"
btn_label: "Learn more"
Find the hotspots in your codebase and make them tangible.
---

**How do you communicate software quality?** CodeCharta is a tool collection that allows you to import and **combine** metrics from various sources like SonarQube, Svn, Git or directly from your source code. It's not tied to a specific programming language and there are several [importers]({{site.baseurl}}{% link _docs/02-03-ccsh.md %}) already provided that you can use to gain metrics. CodeCharta also provides a tool to [visualize]({{site.baseurl}}{% link _docs/04-01-visualization.md %}) these metrics and make the quality of your code base **tangible**, which you in turn can use to gain insights and **communicate with your stakeholders**.
At <a href="https://www.maibornwolff.de/en/">**MaibornWolff**</a>, we love good code and want to contribute to the world to help everyone around us have a better codebase. But before you can change anything, you need to identify and talk about the problems in your codebase.

## CodeCharta Design Goals
CodeCharta is our attempt to make code more **tangible**, so that you can **communicate** with your managers or colleagues about your codebase, analyse it and find **hotspots**.

{% include feature_row %}
## Features

{% include features.html %}

[> Get started now!]({{site.baseurl}}/docs/quick-start-guide/){: .btn--primary.btn}
Binary file removed gh-pages/assets/images/CC-Home.png
Binary file not shown.
Binary file added gh-pages/assets/images/cc_home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh-pages/assets/images/codecharta_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added gh-pages/assets/images/features/cli.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh-pages/assets/images/features/history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh-pages/assets/images/features/imports.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh-pages/assets/images/features/tangible.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh-pages/assets/images/features/visualize.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh-pages/assets/images/mw_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b76173f

Please sign in to comment.