Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
archlitchi committed Apr 24, 2024
1 parent ae430c6 commit b5d338c
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 15 deletions.
6 changes: 1 addition & 5 deletions docs/contributor/contribute-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ If you add a document, you must add it to `sidebars.js` to make it display prope
There are two situations about the Chinese version of the document:
* You want to translate our existing English docs to Chinese. In this case, you need to modify the corresponding file content from <https://github.com/karmada-io/website/tree/main/i18n/zh/docusaurus-plugin-content-docs/current>.
The organization of this directory is exactly the same as the outer layer. `current.json` holds translations for the documentation directory. You can edit it if you want to translate the name of directory.
* You want to contribute Chinese docs without English version. Any articles of any kind are welcomed. In this case, you can add articles and titles to the main directory first. Article content can be TBD first, like [this](../tutorials/karmada-search.md).
* You want to contribute Chinese docs without English version. Any articles of any kind are welcomed. In this case, you can add articles and titles to the main directory first. Article content can be TBD first, like this.
Then add the corresponding Chinese content to the Chinese directory.

## Debugging docs
Expand All @@ -168,12 +168,8 @@ Now you have already completed docs. After you start a PR to `karmada.io/website

Click **Details** marked in red, and you will enter the preview view of the website.

![Docs CI](../resources/contributor/debug-docs.png)

Click **Next** and you can see the corresponding changes. If you have changes related to the Chinese version, click the language drop-down box next to it to switch to Chinese.

![Click next](../resources/contributor/click-next.png)

If the previewed page is not what you expected, please check your docs again.

## FAQ
Expand Down
4 changes: 0 additions & 4 deletions docs/faq/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,12 @@ Both of them are used to hold the propagation declaration, but they have differe

## What is the difference between 'Push' and 'Pull' mode of a cluster?

Please refer to [Overview of Push and Pull](../userguide/clustermanager/cluster-registration.md#overview-of-cluster-mode).

## Why Karmada requires `kube-controller-manager`?

`kube-controller-manager` is composed of a bunch of controllers, Karmada inherits some controllers from it
to keep a consistent user experience and behavior.

It's worth noting that not all controllers are needed by Karmada, for the recommended controllers please
refer to [Recommended Controllers](../administrator/configuration/configure-controllers.md#recommended-controllers).


## Can I install Karmada in a Kubernetes cluster and reuse the kube-apiserver as Karmada apiserver?

Expand Down
7 changes: 1 addition & 6 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -116,11 +116,6 @@ module.exports = {
label: "Documentation",
position: "left",
},
{
to: "blog",
label: "Blog",
position: "left",
},
{
type: "localeDropdown",
position: "right",
Expand Down Expand Up @@ -161,7 +156,7 @@ module.exports = {
},
{
label: "Blog",
to: "blog",
to: "/docs",
},
],
},
Expand Down

0 comments on commit b5d338c

Please sign in to comment.