Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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
Showing
34 changed files
with
224 additions
and
171 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,3 +4,4 @@ Add styles or override variables from the theme here. | |
*/ | ||
|
||
$secondary: #428646; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 >}} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
--- | ||
title: "Kapacity Blog" | ||
linkTitle: "Blog" | ||
title: "Blog" | ||
menu: | ||
main: | ||
weight: 30 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,8 @@ | ||
--- | ||
title: "Documentation" | ||
linkTitle: "Documentation" | ||
weight: 20 | ||
menu: | ||
main: | ||
weight: 20 | ||
--- | ||
|
||
All documents of kapacity |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
3 changes: 1 addition & 2 deletions
3
...cs/contributing/developer-guide/_index.md → ...tion-guidelines/developer-guide/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,7 @@ | ||
--- | ||
title: "Developer Guide" | ||
linkTitle: "Developer Guide" | ||
weight: 7 | ||
description: > | ||
Developer Guide | ||
How to develop Kapacity | ||
--- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
--- | ||
title: "Getting Started" | ||
linkTitle: "Getting Started" | ||
weight: 2 | ||
description: > | ||
Learn how to install and start to use Kapacity | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
--- | ||
title: "Installation" | ||
linkTitle: "Installation" | ||
description: "Installation" | ||
description: "How to install or uninstall Kapacity" | ||
weight: 12 | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
--- | ||
title: "Quick Start" | ||
linkTitle: "Quick Start" | ||
description: "Quick Start" | ||
weight: 13 | ||
|
||
description: > | ||
Getting started to use Kapacity | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: "Roadmap" | ||
weight: 5 | ||
description: > | ||
The roadmap for future releases | ||
--- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,7 @@ | ||
--- | ||
title: "User Guide" | ||
linkTitle: "User Guide" | ||
weight: 3 | ||
description: > | ||
User Guide | ||
Learn how to use Kapacity in detail | ||
--- | ||
|
Oops, something went wrong.