Code Monkey home page Code Monkey logo

website's Introduction

Kosmos Docs & Website

This repo contains the source code of Kosmos website and all of the docs for Kosmos. It's built by Docusaurus, a modern static website generator.

Welcome to join us and you are more than appreciated to contribute!

Add or Update Docs

When you add or modify the docs, these two files(docs/kosmos/docs/ and sidebars.js) should be taken into consideration.

Run with Node.js

If you have the Node.js environment, you can run the website locally.

  • It is recommended to use version node v18.0.0+ and npm v8.6+
  • You can download Node.js
# Clone the repo, or your own fork
git clone https://github.com/<YOUR_GITHUB_USERNAME>/website.git

# Confirm doc update
cd website/kosmos
npm i

# Start the site
npm start

Once the site is running locally, you can preview the site by visiting http://localhost:3111/website/.

Build

This command generates static content into the build directory and can be served using any static contents hosting service.

# Static website update
cd website/kosmos
npm run build -- --out-dir ../docs

Send your pull request

After all changes checked well, please creating a pull request with DCO.

website's People

Contributors

kosmos-robot avatar one7live avatar village-way avatar duanmengkk avatar qiuming520 avatar qiuwei68 avatar wuyingjun-lucky avatar xiaomihuylx avatar

Stargazers

avatar avatar avatar avatar avatar hanweisen avatar avatar avatar Jiao avatar baoyinghai_yewu avatar JohnJan avatar 洪华剑 avatar Jaychou avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar smallyard avatar 江南小书童 avatar

Watchers

hanweisen avatar baoyinghai_yewu avatar avatar avatar avatar avatar

Forkers

xiaomihuylx liuxxio liuxingli2019 yelinxia rxy0210 duanmengkk village-way qiuming520 zhouhaoa1 qiuwei68 one7live

website's Issues

When I follow the Quick Start document Deploy and run Kosmos control plane , When the hack/local-up-kosmosctl.sh command is executed, the error message "no such file or directory: hack/local-up-kosmosctl.sh" is displayed

What happened:
When I follow the Quick Start document Deploy and run Kosmos control plane , When the hack/local-up-kosmosctl.sh command is executed, the error message "no such file or directory: hack/local-up-kosmosctl.sh" is displayed
What you expected to happen:
When the hack/local-up-kosmosctl.sh command is executed, no error is reported and the operation can be normal
How to reproduce it(as minimally and precisely as possible):
Run the hack/local-up-kosmosctl.sh command, and you'll see
Anything else we need to know?
Environment:

  • os: macos
  • kosmos version: main

hack/local-up-kosmosctl.sh command is not found

When I followed the Quick Start document to deploy and run the kosmos control plane, I also found that there is no hack/local-up-kosmosctl.sh command. It is recommended to modify the hack/local-up-kosmosctl.sh command in the document to ./hack /local-up-kosmos.sh

If the apiServerAddress in the config file is 127.0.0.1 when the kind config is used to create a cluster, an error message may be displayed for creating a clusterlink-operator pod

What happened:
When the kind config is used to create a cluster, if the apiServerAddress in the config file is set to 127.0.0.1, an error message is displayed indicating that the clusterlink-operator pod cannot be connected to the api server.
image

What you expected to happen:
When you use the kind config command in this document to create a cluster, the clusterlink-operator pod can be created normally. No error is reported
How to reproduce it(as minimally and precisely as possible):
Follow the kind config configuration in the documentation to create the cluster
Anything else we need to know?
Environment:

os: macos
kosmos version: main

The execution order of the two sections Deploy and run Kosmos control plane use script and Deploy and run Kosmos step by step is vague

What happened:
The sections Deploy and run Kosmos control plane use script and Deploy and run Kosmos step by step in the Quick Start document should choose one of them. However, it is not explicitly stated in the documentation. For beginners, Deploy and run Kosmos control plane use script may be executed first, followed by Deploy and run Kosmos step by step
What you expected to happen:
Note In the document, you can select either Deploy and run Kosmos control plane use script or Deploy and run Kosmos step by step
How to reproduce it(as minimally and precisely as possible):
Anything else we need to know?
Environment:

os: macos
kosmos version: main

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.