Skip to content

Commit

Permalink
Init website (traas-stack#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
dayko2019 authored May 26, 2023
1 parent b971f05 commit 9967fb7
Show file tree
Hide file tree
Showing 33 changed files with 541 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/public
resources/
node_modules/
package-lock.json
.hugo_build.lock
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# kapacity-docs
# Kapacity Website
6 changes: 6 additions & 0 deletions assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/*
Add styles or override variables from the theme here.
*/

218 changes: 218 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
baseURL = "/"
title = "Kapacity"

# Language settings
contentDir = "content/en"
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = false
# Useful when translating.
enableMissingTranslationPlaceholders = true

enableRobotsTXT = true

# Will give values to .Lastmod etc.
enableGitInfo = true

# Comment out to enable taxonomies in Docsy
disableKinds = ["taxonomy", "taxonomyTerm"]

# You can add your own taxonomies
#[taxonomies]
#tag = "tags"
#category = "categories"

[params.taxonomy]
# set taxonomyCloud = [] to hide taxonomy clouds
# taxonomyCloud = ["tags", "categories"]

# If used, must have same length as taxonomyCloud
# taxonomyCloudTitle = ["Tag Cloud", "Categories"]

# set taxonomyPageHeader = [] to hide taxonomies on the page headers
# taxonomyPageHeader = ["tags", "categories"]


# Highlighting config
pygmentsCodeFences = true
pygmentsUseClasses = false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic = false
#pygmentsOptions = "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle = "tango"

# Configure how URLs look like per section.
[permalinks]
blog = "/:section/:year/:month/:day/:slug/"

# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

[services]
[services.googleAnalytics]
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
# id = "UA-00000000-0"

# Language configuration

[languages]
[languages.en]
title = "Kapacity"
description = "Cloud Native Intelligent Elastic Capacity"
languageName ="English"
# Weight used for sorting.
weight = 1
[languages.zh]
title = "Kapacity"
description = "云原生智能弹性容量"
languageName ="中文"
weight = 2
contentDir = "content/zh"
time_format_default = "02.01.2006"
time_format_blog = "02.01.2006"

[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
# style = "tango"
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax = "true"

# Everything below this are Site Params

# Comment out if you don't want the "print entire section" link enabled.
[outputs]
section = ["HTML", "print", "RSS"]

[params]
copyright = "The Kapacity Authors"

# Menu title if your navbar has a versions selector to access old versions of your site.
# This menu appears only if you have at least one [params.versions] set.
version_menu = "Releases"

sectionPagesMenu = 'main'

# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version = false

# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
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"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/traas-stack/kapacity"
# 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"

# Specify a value here if your content directory is not in your repo's root directory
# github_subdir = ""

# Uncomment this if your GitHub repo does not have "main" as the default branch,
# or specify a new value if you want to reference another branch in your GitHub links
github_branch= "main"

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

# Enable Algolia DocSearch
algolia_docsearch = false

# Enable Lunr.js offline search
offlineSearch = false

# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting = true

# User interface configuration
[params.ui]
# 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
# 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.
navbar_translucent_over_cover_disable = false
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact = false
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable = false

# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
# add "hide_feedback: true" to the page's front matter.
[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>.'

# 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,
# add "hide_readingtime: true" to the page's front matter
[params.ui.readingtime]
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"
[[params.links.user]]
name ="Twitter"
url = "https://example.org/twitter"
icon = "fab fa-twitter"
desc = "Follow us on Twitter to get the latest news!"
[[params.links.user]]
name = "Stack Overflow"
url = "https://example.org/stack"
icon = "fab fa-stack-overflow"
desc = "Practical questions and curated answers"
# 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"
icon = "fab fa-slack"
desc = "Chat with other project developers"
[[params.links.developer]]
name = "Developer mailing list"
url = "https://example.org/mail"
icon = "fa fa-envelope"
desc = "Discuss development issues around the project"

# hugo module configuration

[module]
# uncomment line below for temporary local development of module
# replacements = "github.com/google/docsy -> ../../docsy"
[module.hugoVersion]
extended = true
min = "0.75.0"
[[module.imports]]
path = "github.com/google/docsy"
disable = false
[[module.imports]]
path = "github.com/google/docsy/dependencies"
disable = false
45 changes: 45 additions & 0 deletions content/en/_index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
+++
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>
</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>
<p class="lead mt-5" style="font-size: 26px;">A cloud-native intelligent capacity elasticity technology.</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 .
{{% /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="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 %}}


{{% blocks/feature icon="fa fa-envelope" title="Email" %}}
If you have a good idea, you can contact us by email: [email protected]

{{% /blocks/feature %}}


{{< /blocks/section >}}


7 changes: 7 additions & 0 deletions content/en/blog/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Kapacity Blog"
linkTitle: "Blog"
menu:
main:
weight: 30
---
8 changes: 8 additions & 0 deletions content/en/community/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Community
menu:
main:
weight: 40
---

<!--add blocks of content here to add more sections to the community page -->
10 changes: 10 additions & 0 deletions content/en/docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Documentation"
linkTitle: "Documentation"
weight: 20
menu:
main:
weight: 20
---

All documents of kapacity
7 changes: 7 additions & 0 deletions content/en/docs/contributing/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Contributing"
linkTitle: "Contributing"
weight: 4
description: >
How to contribute to Kapacity
---
8 changes: 8 additions & 0 deletions content/en/docs/contributing/developer-guide/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Developer Guide"
linkTitle: "Developer Guide"
weight: 7
description: >
Developer Guide
---

7 changes: 7 additions & 0 deletions content/en/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Getting Started"
linkTitle: "Getting Started"
weight: 2
description: >
---
7 changes: 7 additions & 0 deletions content/en/docs/getting-started/installation/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Installation"
linkTitle: "Installation"
description: "Installation"
weight: 12

---
7 changes: 7 additions & 0 deletions content/en/docs/getting-started/quick-start/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Quick Start"
linkTitle: "Quick Start"
description: "Quick Start"
weight: 13

---
8 changes: 8 additions & 0 deletions content/en/docs/introduction/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Introduction"
linkTitle: "Introduction"
weight: 1
description: >
Introduction to kapacity.
---

8 changes: 8 additions & 0 deletions content/en/docs/user-guide/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "User Guide"
linkTitle: "User Guide"
weight: 3
description: >
User Guide
---

6 changes: 6 additions & 0 deletions content/en/search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Search Results
layout: search

---

Loading

0 comments on commit 9967fb7

Please sign in to comment.