Giter VIP home page Giter VIP logo

devcenter's Introduction

Bitrise DevCenter

Feel free to edit any page & to send us a Pull Request!!

Note: you can edit the pages on GitHub directly, you don't even have to git clone the repository. Just select the file on GitHub and click the pencil/edit icon, which will open the GitHub editor for the file. Example for this page.

The deployed documentation can be found at http://devcenter.bitrise.io, which is a statically generated site, based on this repository's /docs directory. All links in the articles are relative to the /docs directory!

If you don't want to edit the page on GitHub, feel free to contact us, and we'll do the change for you!

Category notes

  • tips-and-tricks vs tutorials : tutorials have to include a complete guide as much as possible, e.g. steps to register the repository/app. tips-and-tricks is short, only describes the thing it wants to achieve. Later can be moved into tutorial, by adding more info.

API docs - edit the .gg files!!

API responses and the whole .md files are auto-generated; please edit the .md.gg template files instead of editing the .md directly!

To add a new endpoint documentation section:

  • open the docs/api/vX.md.gg template file
  • add the endpoint section, following the other endpoints' doc structure
  • add the example endpoint call to the _scripts/gen_api_docs_gotgen_config.go file (using the api-demo bitrise.io user to locate the right example URL, e.g. if it have to include a repo/build/... slug)
  • use that in the example response section of the endpoint ({{ (var "/URL-PATH").HTTPMETHOD }})
  • and finally, run: bitrise run generate-api-docs to generate the .md from the .md.gg

devcenter's People

Contributors

viktorbenei avatar slapec93 avatar zoltan-baba avatar birmacher avatar koral-- avatar bloodrabbit avatar banyikanna avatar godrei avatar dbreuer avatar gaborszakacs avatar doomsayer13 avatar trapacska avatar amarron1 avatar brad avatar lyricsboy avatar cmbleakley avatar eberleinf avatar fdnhkj avatar hesamedin avatar kwoylie avatar morgsteffy avatar niksawtschuk avatar motorro avatar ranunez avatar gausam avatar erosdome-personal 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.