Git Product home page Git Product logo

kubecube-io.github.io's Introduction

KubeCube docs

License build

Welcome! This repository houses all the assets required to build the KubeCube website and documentation. We're pleased that you want to contribute! The website is hosted at https://kubecube.io.

We use Hugo to format and generate our website, the Docsy theme for styling and site structure. Thanks!.

Contribution

  1. Fork this repository

  2. Clone the code and submodules

    $ git clone --recurse-submodules https://github.com/kubecube-io/kubecube-io.github.io.git
    
  3. Make your changes and send a pull request (PR).

  4. Merge the pull request

    Once your pull request is created, a KubeCube reviewer will take responsibility for providing clear, actionable feedback, re-improve and merge.

Previewing your changes on a local website server

If you'd like to preview your doc updates as you work, you can install Hugo and run a local server to host your website. This section shows you how.

Install Hugo and other dependencies

You need Hugo version 0.81or later, and it must be the extended version of Hugo.

To get the latest extended version of Hugo:

  1. Go to the Hugo releases page.
  2. In the most recent release, scroll down until you find a list of extended versions.
  3. Download the relevant file for your operating system.
  4. Unzip the downloaded file into a location of your choice.

For more details about installing Hugo, See the Hugo installation guide.

**Not Necessary:**If you plan to make changes to the site styling, you need to install some CSS libraries as well. Follow the instructions in the Docsy theme's setup guide.

Run a local website server

  1. Fork this repository and clone it

    $ git clone --recurse-submodules https://github.com/kubecube-io/kubecube-io.github.io.git
    $ cd kubecube-io.github.io
    
  2. Start your website server. Make sure you run this command from the kubecube-io.github.io directory, so that Hugo can find the config files it needs:

    hugo server
    
  3. You can access your website at http://localhost:1313/ (bind address 127.0.0.1)

After clone this repository ,Make sure you run this command from the /website/ directory, so that Hugo can find the config files it needs:kubecube-io.github.io

Useful docs

Thanks

KubeCube thrives on community participation, and we really appreciate your contributions to our site and our documentation!

kubecube-io.github.io's People

Contributors

weilaaa avatar zhujf1989 avatar fusidamj avatar jiahuizhao11 avatar just1900 avatar

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.