Code Monkey home page Code Monkey logo

docs.fission.io's Introduction

To read the Fission docs, go to: docs.fission.io.


Fission Docs Source Repo

This is the source for the docs.fission.io website. It contains docs for both the Fission and Fission Workflows projects.

Repo organization and building

This is a hugo statically-generated site, hosted on netlify. The site is automatically built by netlify (see netlify.toml and build.sh).

  • docs/ is the source. It's a hugo site.
    • docs/content this is where the documentation content lives.
    • docs/config.toml is some hugo configuration, such as the base URL of the website, the theme etc.
  • dist/ is the directory that's actually served at https://docs.fission.io
    • dist/archive has older versions of the docs are archived here. These are kept for reference purpose and will be eventually removed. All older versions are redirected to current version of docs
    • dist/public is the root of latest/live documentation
  • build.sh is run by netlify. It runs hugo and places the generated site under dist/public

Making changes

Adding a new doc

cd docs/
hugo new usage/how-to-use-ShinyNewThing.md

Modifying an existing doc

Find the doc under docs/content, edit it, make a pull request. You can use Github's handy UI for editing docs.

Previewing your changes

cd docs/
hugo serve -D
# This will output a link that you can open in a browser.

Publishing your changes

Make a pull request with your changes to the source. There should be no changes under the dist directory. When the pull request is merged the site will automatically be updated by netlify.

docs.fission.io's People

Contributors

bhavin192 avatar danielwhatmuff avatar dataground avatar douglas-vaz avatar erwinvaneyk avatar gguttikonda avatar joshkelly avatar life1347 avatar ramonpires avatar rcarle3911 avatar smruthi2187 avatar soamvasani avatar starefossen avatar timirahj avatar vishal-biyani avatar viveksinghggits 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.