Giter Site home page Giter Site logo

plasticine / docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from buildkite/docs

1.0 1.0 0.0 37.19 MB

The source files for the Buildkite documentation

License: MIT License

HTML 87.06% Shell 0.51% Dockerfile 0.22% Ruby 8.82% JavaScript 0.01% SCSS 3.37%

docs's Introduction

Buildkite Documentation Build status

The source files for the Buildkite Documentation.

To contribute, send a pull request! ❤️

Development

git clone https://github.com/buildkite/docs.git
git submodule update --init

If you have Ruby installed:

# Install the dependencies
bundle
# Run the specs
bundle exec rspec
# Start the app on http://localhost:3000/
bin/rails server

Or if you have Docker installed:

# Run the specs
docker-compose run app bundle exec rspec
# Start the app on http://localhost:3000/
docker-compose up --build
# To start it in production mode on http://localhost:3000/
docker-compose -f docker-compose.production.yml up --build

Linting

We spell-check the docs (American English) and run a few automated checks for repeated words and other common errors.

If you've added a new valid word that showing up as a spelling error, add it to vale/vocab.txt.

Search index

The search index is updated once a day by a scheduled build using the config in config/algolia.json. To test changes to the indexing configuration (you'll need an API key) run rake update_test_index.

License

See LICENSE.md (MIT)

docs's People

Contributors

ahawkins avatar andor-pierdelacabeza avatar arturt avatar blakestoddard avatar blaknite avatar chloeruka avatar dependabot[bot] avatar eleanorakh avatar garypwhite avatar harrietgrace avatar hzrdirl avatar imgbotapp avatar jj-bk avatar joscha avatar juanitofatas avatar karensawrey avatar keithpitt avatar lox avatar mjwitherow avatar pda avatar philwo avatar plaindocs avatar plasticine avatar scopegate avatar sebelino avatar sj26 avatar starfallprojects avatar ticky avatar toolmantim avatar yob avatar

Stargazers

 avatar

Watchers

 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.