Code Monkey home page Code Monkey logo

kubeless-website's Introduction

Build Status

Kubeless site

This repository contains the kubeless.io source code. We use middleman to generate the final HTML code.

We recommend you the middlemant documentation site. There you will find useful tutorials, videos and advanced configuration guides.

Structure

This project follows the basic structure of middleman projects. All the files related to the site generation are located in the source folder. In this folder, we can find the following files and folders:

  • assets: it includes all the files related to the frontend. Here we will place images, styles and javascript files.
  • layouts: these are the middleman layouts. It defines the basic layout for all the pages but you can create new ones if it's required. Also, we use partials to reduce the HAML code in main layout.
  • x.html.md: All the pages of the site, written in markdown.

To define custom data to inject to the project we can use the data folder. It also includes an YAML example file with some links to Bitnami products. You have more information about custom data in the middleman documentation.

If you need to add any Ruby code to the project, you can create the files in the lib folder. These files will be load automatically by middleman. The middlman documentation includes more information about helpers and external ruby dependencies.

Once we build the project, all the files will be placed in the build folder. These files can be served directly in server.

Configuration

All the middleman configuration is present in the config.rb file. As you can see, the file is very simple. This is intentional because every project is different and it will require a different configuration. The config file only applies the common configuration of all our projects.

Development

To start the development server execute the following command:

docker-compose up -d

The example site will be available on http://localhost:4567. The domain can change depending on your docker configuration. If you're using docker in a virtual machine, please check the Docker Machine section.

All the changes you perform in the config.rb file and the source folder will be applied directly. Once you reload the page, the changes will appear.

Docker Machine

If you're running docker in a virtual machine, the URL of the project will be http://VIRTUAL_MACHINE_IP:4567. Remember to change the VIRTUAL_MACHINE_IP placeholder with the IP of your virtual machine.

Deployment

This project is deployed through Travis CI and it uses GitHub pages as hosting. On every commit in master, the site is deployed automatically.

kubeless-website's People

Contributors

angelmmiguel avatar arapulido avatar remstos avatar sebgoa avatar

Watchers

 avatar  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.