Clone or download
Permalink
Failed to load latest commit information.
.forestry Update from Forestry.io - Created getting-started-with-ionic-cordova-… Nov 16, 2018
_articles Update from Forestry.io - Updated device-testing-for-ios.md Nov 16, 2018
_data Update from Forestry.io - Updated menus Oct 29, 2018
_includes Message box update (#301) Sep 13, 2018
_layouts feat(search): Added Algolia search. (#389) Oct 18, 2018
_scripts Add documentation for bitrise.yml show of build (#276) Aug 23, 2018
assets Update main.scss Oct 19, 2018
.gitignore Removing .DS_Store (#323) Oct 12, 2018
404.html Jekyll migration (#291) Sep 12, 2018
CNAME Add LICENSE and CNAME files (#293) Sep 12, 2018
Gemfile Update gemfile, package file (#410) Nov 5, 2018
Gemfile.lock Update gemfile, package file (#410) Nov 5, 2018
LICENSE Add LICENSE and CNAME files (#293) Sep 12, 2018
README.md Jekyll migration (#291) Sep 12, 2018
_config.yml Update _config.yml Oct 19, 2018
apple-touch-icon-120x120-precomposed.png Jekyll migration (#291) Sep 12, 2018
apple-touch-icon-120x120.png Jekyll migration (#291) Sep 12, 2018
apple-touch-icon-152x152-precomposed.png Jekyll migration (#291) Sep 12, 2018
apple-touch-icon-152x152.png Jekyll migration (#291) Sep 12, 2018
apple-touch-icon-76x76-precomposed.png Jekyll migration (#291) Sep 12, 2018
apple-touch-icon-76x76.png Jekyll migration (#291) Sep 12, 2018
apple-touch-icon-precomposed.png Jekyll migration (#291) Sep 12, 2018
apple-touch-icon.png Jekyll migration (#291) Sep 12, 2018
bitrise.yml Fix app registration related API documentation (#411) Nov 7, 2018
favicon.ico Jekyll migration (#291) Sep 12, 2018
favicon.png Jekyll migration (#291) Sep 12, 2018
favicon.svg Jekyll migration (#291) Sep 12, 2018
forestry-help-menus.md Update from Forestry.io - Updated forestry-help-menus.md Sep 13, 2018
forestry-help.md Update from Forestry.io - Updated forestry-help.md Sep 28, 2018
package-lock.json Update gemfile, package file (#410) Nov 5, 2018
package.json Update gemfile, package file (#410) Nov 5, 2018
search.json Jekyll migration (#291) Sep 12, 2018

README.md

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 /_articles directory. All links in the articles are relative to the /_articles 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 _articles/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