Skip to content

Commit

Permalink
update website
Browse files Browse the repository at this point in the history
* rewrite index page
* write contribution page contents
* add roadmap page
* add community information
* change search method to local search
* change contributing url path to contribution-guidelines (because the community page of docsy hard-code this link)
* rename Chinese contents dir to zh-cn (because this is the standard i18n name in docsy)
* other tweaks
  • Loading branch information
zqzten committed May 29, 2023
1 parent 99c27e8 commit edf4c4e
Show file tree
Hide file tree
Showing 34 changed files with 224 additions and 171 deletions.
1 change: 1 addition & 0 deletions assets/scss/_variables_project.scss
Expand Up @@ -4,3 +4,4 @@ Add styles or override variables from the theme here.
*/

$secondary: #428646;
74 changes: 38 additions & 36 deletions config.toml
@@ -1,4 +1,4 @@
baseURL = "/"
baseURL = "https://kapacity.netlify.app"
title = "Kapacity"

# Language settings
Expand Down Expand Up @@ -61,18 +61,20 @@ anchor = "smart"
[languages]
[languages.en]
title = "Kapacity"
description = "Cloud Native Intelligent Elastic Capacity"
languageName ="English"
languageName = "English"
# Weight used for sorting.
weight = 1
[languages.zh]
[languages.en.params]
description = "An open cloud native capacity solution which helps you achieve ultimate resource utilization in an intelligent and risk-free way."
[languages.zh-cn]
title = "Kapacity"
description = "云原生智能弹性容量"
languageName ="中文"
languageName = "中文"
weight = 2
contentDir = "content/zh"
time_format_default = "02.01.2006"
time_format_blog = "02.01.2006"
contentDir = "content/zh-cn"
[languages.zh-cn.params]
description = "Kapacity 旨在为用户提供一套具备完善技术风险能力的、智能且开放的云原生容量技术,帮助用户安全稳定地实现极致降本增效,解决容量相关问题。"
time_format_default = "2006/01/02"
time_format_blog = "2006/01/02"

[markup]
[markup.goldmark]
Expand Down Expand Up @@ -111,10 +113,10 @@ version = "0.0"

# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version = "https://example.com"
url_latest_version = "https://kapacity.netlify.app"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/traas-stack/kapacity"
github_repo = "https://github.com/traas-stack/kapacity-website"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/traas-stack/kapacity"

Expand All @@ -126,13 +128,13 @@ github_project_repo = "https://github.com/traas-stack/kapacity"
github_branch= "main"

# Google Custom Search Engine ID. Remove or comment out to disable search.
gcs_engine_id = "d72aa9b2712488cc3"
# gcs_engine_id = "d72aa9b2712488cc3"

# Enable Algolia DocSearch
algolia_docsearch = false

# Enable Lunr.js offline search
offlineSearch = false
offlineSearch = true

# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting = true
Expand All @@ -142,7 +144,7 @@ prism_syntax_highlighting = true
# Set to true to disable breadcrumb navigation.
breadcrumb_disable = false
# Set to true to disable the About link in the site footer
footer_about_disable = false
footer_about_disable = true
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
navbar_logo = true
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
Expand All @@ -159,8 +161,8 @@ sidebar_search_disable = false
[params.ui.feedback]
enable = false
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
yes = 'Glad to hear it! Please <a href="https://github.com/traas-stack/kapacity-website/issues/new">tell us how we can improve</a>.'
no = 'Sorry to hear that. Please <a href="https://github.com/traas-stack/kapacity-website/issues/new">tell us how we can improve</a>.'

# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
Expand All @@ -171,36 +173,36 @@ enable = true
[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
[[params.links.user]]
name = "User mailing list"
url = "https://example.org/mail"
icon = "fa fa-envelope"
desc = "Discussion and help from your fellow users"
name = "GitHub Discussions"
url = "https://github.com/traas-stack/kapacity/discussions"
icon = "fab fa-github"
desc = "Discussion and help from developers and your fellow users."
[[params.links.user]]
name ="Twitter"
url = "https://example.org/twitter"
icon = "fab fa-twitter"
desc = "Follow us on Twitter to get the latest news!"
name ="Slack"
url = "https://join.slack.com/t/traas-kapacity/shared_invite/zt-1w1esmmk5-bNy3~IuGeCWQ21UmCexcrA"
icon = "fab fa-slack"
desc = "Chat with developers and other users in #users (mainly in English)."
[[params.links.user]]
name = "Stack Overflow"
url = "https://example.org/stack"
icon = "fab fa-stack-overflow"
desc = "Practical questions and curated answers"
name = "DingTalk"
url = "https://qr.dingtalk.com/action/joingroup?code=v1,k1,7qkY1oyphgJvdUE4nJ1EcnNvE2JhmoNXBgdVTvD3AX0=&_dt_no_comment=1&origin=11"
icon = "fa fa-comments"
desc = "Chat with developers and other users (mainly in Chinese). Group Number: 27855025593"
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
[[params.links.developer]]
name = "GitHub"
url = "https://github.com/traas-stack/kapacity"
icon = "fab fa-github"
desc = "Development takes place here!"
[[params.links.developer]]
name = "Slack"
url = "https://example.org/slack"
name ="Slack"
url = "https://join.slack.com/t/traas-kapacity/shared_invite/zt-1w1esmmk5-bNy3~IuGeCWQ21UmCexcrA"
icon = "fab fa-slack"
desc = "Chat with other project developers"
desc = "Chat with other developers in #developers (mainly in English)."
[[params.links.developer]]
name = "Developer mailing list"
url = "https://example.org/mail"
icon = "fa fa-envelope"
desc = "Discuss development issues around the project"
name = "DingTalk"
url = "https://qr.dingtalk.com/action/joingroup?code=v1,k1,7qkY1oyphgJvdUE4nJ1EcnNvE2JhmoNXBgdVTvD3AX0=&_dt_no_comment=1&origin=11"
icon = "fa fa-comments"
desc = "Chat with other developers (mainly in Chinese). Group Number: 27855025593"

# hugo module configuration

Expand All @@ -215,4 +217,4 @@ enable = true
disable = false
[[module.imports]]
path = "github.com/google/docsy/dependencies"
disable = false
disable = false
42 changes: 26 additions & 16 deletions content/en/_index.html
@@ -1,45 +1,55 @@
+++
title = "Kapacity"
linkTitle = "Kapacity"

+++

{{< blocks/cover title="Welcome to Kapacity!" image_anchor="top" color="primary" >}}

<div class="mx-auto">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Get Started <i class="fas fa-arrow-alt-circle-right ml-2"></i>
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/traas-stack/kapacity.git">
Download <i class="fab fa-github ml-2 "></i>
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/traas-stack/kapacity">
GitHub <i class="fab fa-github ml-2 "></i>
</a>
<p class="lead mt-5" style="font-size: 26px;">A cloud-native intelligent capacity elasticity technology.</p>
<p class="lead mt-5" style="font-size: 26px;">
An open cloud native capacity solution which helps you achieve ultimate resource utilization in an intelligent and risk-free way.
</p>
{{< blocks/link-down color="info" >}}
</div>
{{< /blocks/cover >}}


{{% blocks/lead color="primary" %}}
Kapacity is based on Ant's internal ultra-large-scale production business practice, and aims to provide users with a set of intelligent and open cloud-native capacity technologies with complete technical risk capabilities, helping users to safely and stably achieve extreme cost reduction and efficiency increase, and solve capacity-related problems .
Kapacity is built upon core ideas and years of experience of the large-scale production capacity system at Ant Group, which saves ~100k cores yearly with high stability and zero downtime, combined with best practices from the cloud native community.

It aims to automate your scaling, mitigate capacity risks, save your effort as well as cost.
{{% /blocks/lead %}}


{{< blocks/section color="white" >}}
{{% blocks/feature icon="fa-book" title="Introduction" url="/docs" %}}
Kapacity is a cloud-native intelligent capacity elasticity technology.
{{% /blocks/feature %}}

{{% blocks/feature icon="fa-anchor" title="Kubernetes Native" url="/docs/getting-started/installation" %}}
Kapacity is an out-of-the-box add-on of Kubernetes. Easy to install and use for k8s users.
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-github" title="Contributing" url="https://github.com/traas-stack/kapacity.git" %}}
We do a [Pull Request](https://github.com/traas-stack/kapacity/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% blocks/feature icon="fa-cubes" title="Intelligent HPA" url="/docs" %}}
An intelligent, risk-defensive, highly adaptive and customizable substitution for Kubernetes HPA.
{{% /blocks/feature %}}

{{% blocks/feature icon="fa-puzzle-piece" title="Open And Extensible" %}}
Kapacity is born to be an open project which is easy to integrate or extend.
{{% /blocks/feature %}}

{{% blocks/feature icon="fa fa-envelope" title="Email" %}}
If you have a good idea, you can contact us by email: traaskapacity.io@gmail.com
{{% blocks/feature icon="fa-lightbulb" title="And More..." url="/docs/roadmap" %}}
More exciting features are comming, stay tuned :)
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-github" title="Contributing Welcomed" url="/docs/contribution-guidelines" %}}
Any form of contributing is warmly welcomed 🤗
{{% /blocks/feature %}}

{{% blocks/feature icon="fa fa-users" title="Community Open" url="/community" %}}
Feel free to directly talk to us through community if you have any wish or doubt.
{{% /blocks/feature %}}

{{< /blocks/section >}}


3 changes: 1 addition & 2 deletions content/en/blog/_index.md
@@ -1,6 +1,5 @@
---
title: "Kapacity Blog"
linkTitle: "Blog"
title: "Blog"
menu:
main:
weight: 30
Expand Down
2 changes: 0 additions & 2 deletions content/en/docs/_index.md
@@ -1,10 +1,8 @@
---
title: "Documentation"
linkTitle: "Documentation"
weight: 20
menu:
main:
weight: 20
---

All documents of kapacity
7 changes: 0 additions & 7 deletions content/en/docs/contributing/_index.md

This file was deleted.

29 changes: 29 additions & 0 deletions content/en/docs/contribution-guidelines/_index.md
@@ -0,0 +1,29 @@
---
title: "Contributing"
weight: 4
description: >
How to contribute to Kapacity
---

Welcome to Kapacity!

Thank you so much for helping Kapacity become better.

Please note that contributing code is not the only way of contributing, there are many other forms of contributions that are also welcomed, such as:

* Answering questions in [GitHub Discussions](https://github.com/traas-stack/kapacity/discussions)
* Submitting bug report or feature request in [GitHub Issues](https://github.com/traas-stack/kapacity/issues)
* Reviewing others code in [GitHub Pull Requests](https://github.com/traas-stack/kapacity/pulls)
* Contributing to [documentations](https://github.com/traas-stack/kapacity-website)

Here's the guideline for some contribution ways.

## Submitting issues

Before submitting an issue, please check whether there has been similar existing issues and avoid duplicating them.

If you want to report a security vulnerability, make sure to choose the "Report a security vulnerability" option in "New issue". Do not submit it as a normal public issue.

## Contributing code

For code related contributions, please read the [developer guide](/docs/contribution-guidelines/developer-guide/) to get started.
@@ -1,8 +1,7 @@
---
title: "Developer Guide"
linkTitle: "Developer Guide"
weight: 7
description: >
Developer Guide
How to develop Kapacity
---

3 changes: 1 addition & 2 deletions content/en/docs/getting-started/_index.md
@@ -1,7 +1,6 @@
---
title: "Getting Started"
linkTitle: "Getting Started"
weight: 2
description: >
Learn how to install and start to use Kapacity
---
3 changes: 1 addition & 2 deletions content/en/docs/getting-started/installation/_index.md
@@ -1,7 +1,6 @@
---
title: "Installation"
linkTitle: "Installation"
description: "Installation"
description: "How to install or uninstall Kapacity"
weight: 12

---
5 changes: 2 additions & 3 deletions content/en/docs/getting-started/quick-start/_index.md
@@ -1,7 +1,6 @@
---
title: "Quick Start"
linkTitle: "Quick Start"
description: "Quick Start"
weight: 13

description: >
Getting started to use Kapacity
---
2 changes: 1 addition & 1 deletion content/en/docs/introduction/_index.md
Expand Up @@ -3,6 +3,6 @@ title: "Introduction"
linkTitle: "Introduction"
weight: 1
description: >
Introduction to kapacity.
Overall introduction to Kapacity
---

7 changes: 7 additions & 0 deletions content/en/docs/roadmap/_index.md
@@ -0,0 +1,7 @@
---
title: "Roadmap"
weight: 5
description: >
The roadmap for future releases
---

3 changes: 1 addition & 2 deletions content/en/docs/user-guide/_index.md
@@ -1,8 +1,7 @@
---
title: "User Guide"
linkTitle: "User Guide"
weight: 3
description: >
User Guide
Learn how to use Kapacity in detail
---

0 comments on commit edf4c4e

Please sign in to comment.