Skip to content

Commit

Permalink
Jekyll migration (#291)
Browse files Browse the repository at this point in the history
  • Loading branch information
erosdome authored and gaborszakacs committed Sep 12, 2018
1 parent 6101d55 commit b39cdf0
Show file tree
Hide file tree
Showing 484 changed files with 4,829 additions and 2,555 deletions.
9 changes: 9 additions & 0 deletions .forestry/front_matter/templates/article.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
label: article
hide_body: false
is_partial: false
fields:
- type: text
name: title
config:
required: true
16 changes: 16 additions & 0 deletions .forestry/settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
new_page_extension: md
auto_deploy: false
admin_path:
webhook_url:
sections:
- type: directory
path: _articles
label: Articles
create: all
match: "**/*"
upload_dir: _articles/img
public_path: "/img"
front_matter_path: ''
use_front_matter_path: false
file_template: ":filename:"
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site/
.bitrise*
.directory
node_modules
gg.conf.json
_site
.bitrise.secrets.yml
1 change: 0 additions & 1 deletion .python-version

This file was deleted.

24 changes: 24 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
layout: default
---

<style type="text/css" media="screen">
.container {
margin: 10px auto;
max-width: 600px;
text-align: center;
}
h1 {
margin: 30px 0;
font-size: 4em;
line-height: 1;
letter-spacing: -1px;
}
</style>

<div class="container">
<h1>404</h1>

<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>
32 changes: 32 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
source "https://rubygems.org"

# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
gem "jekyll", "~> 3.8.3"

# This is the default theme for new Jekyll sites. You may change this to anything you like.
gem "minima", "~> 2.0"

# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins

# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.6"
gem "jekyll-sitemap"
gem "jekyll-menus"
end

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.0" if Gem.win_platform?

80 changes: 80 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.2)
public_suffix (>= 2.0.2, < 4.0)
colorator (1.1.0)
concurrent-ruby (1.0.5)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
ffi (1.9.25)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.8.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
kramdown (~> 1.14)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-feed (0.10.0)
jekyll (~> 3.3)
jekyll-menus (0.6.0)
jekyll (~> 3.1)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-seo-tag (2.5.0)
jekyll (~> 3.3)
jekyll-sitemap (1.2.0)
jekyll (~> 3.3)
jekyll-watch (2.0.0)
listen (~> 3.0)
kramdown (1.17.0)
liquid (4.0.0)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
minima (2.5.0)
jekyll (~> 3.5)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
pathutil (0.16.1)
forwardable-extended (~> 2.6)
public_suffix (3.0.2)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (3.2.0)
ruby_dep (1.5.0)
safe_yaml (1.0.4)
sass (3.5.7)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)

PLATFORMS
ruby

DEPENDENCIES
jekyll (~> 3.8.3)
jekyll-feed (~> 0.6)
jekyll-menus
jekyll-sitemap
minima (~> 2.0)
tzinfo-data

BUNDLED WITH
1.14.6
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and click the **pencil/edit** icon,
which will open the GitHub editor for the file.
[Example for this page](https://github.com/bitrise-io/devcenter/edit/master/README.md).

The deployed documentation can be found at [http://devcenter.bitrise.io](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!
The deployed documentation can be found at [http://devcenter.bitrise.io](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](https://www.bitrise.io/contact),
Expand All @@ -29,7 +29,7 @@ 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
- 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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
---
title: App Status Image/Badge API
menu:
api:
weight: 2

---
With the `Status Image API token`, you can get an embeddable SVG badge image, a JSON message reflecting the status of the app, or a specific branch of the app.

1. Open your App on [bitrise.io](https://www.bitrise.io) and click the badge image right next to the app's name.

![Printscreen](/img/api/status-image-api-token.jpg)

2. In the `Status image` popup, you can optionally set a branch, and get copy-paste-ready `Embed` codes for the SVG image.
2. In the `Status image` popup, you can optionally set a branch, and get copy-paste-ready `Embed` codes for the SVG image.


!!! example "Example SVG URL"
Expand Down Expand Up @@ -44,4 +51,4 @@ If the `APP-ID` and the `STATUS-IMAGE-API-TOKEN` parameters are correct,
and they identify an existing app, a __200__ HTTP code is returned along with the JSON response, even if the branch parameter points to a non-existing branch (the JSON response in this case will be `{"status": "unknown"}` with a 200 HTTP code).

If the `APP-ID` or the `STATUS-IMAGE-API-TOKEN` (or both) is not correct,
you'll get a HTTP __403__ code _with an empty response_ body.
you'll get a HTTP __403__ code _with an empty response_ body.
10 changes: 8 additions & 2 deletions docs/api/build-trigger.md → _articles/api/build-trigger.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Build Trigger API
menu:
api:
weight: 1

---
_Note: the `www` endpoint is now deprecated. Please use the `https://app.bitrise.io/app/APP-SLUG/build/start.json` endpoint instead._

With the Build Trigger API you can start a new build of your app with a simple API call.
Expand Down Expand Up @@ -176,5 +183,4 @@ the call will look like this:

```
curl -H 'Content-Type: application/json' https://app.bitrise.io/app/APP-SLUG/build/start.json --data '{"hook_info":{"type":"bitrise","build_trigger_token":"APP-API-TOKEN"},"build_params":{"branch":"master","commit_message":"Environment in API params test","workflow_id":"deployment","environments":[{"mapped_to":"API_TEST_ENV","value":"This is the test value","is_expand":true}]}}'
```

```
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Outgoing Webhooks
menu:
api:
weight: 3

---
By setting up outgoing webhooks you can make Bitrise send notifications about specific events to your web service, so you can create custom integrations.

You can set the URL of your web service and select which events should trigger a notification in the Code tab of your app. Currently only build events are supported: a notification is sent when a build starts or finishes.
Expand Down Expand Up @@ -64,4 +71,4 @@ Payload example:
"tag":"v1.0" # If the build was triggered by tag
}
}
```
```
9 changes: 8 additions & 1 deletion docs/api/v0.1.md → _articles/api/v0.1.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Bitrise.io API v0.1 (Work In Progress)
menu:
api:
weight: 4

---
!!! warning "The API is work-in-progress"
The API is work-in-progress, we'll add docs for new endpoints here as we progress,
as well as we might change things a bit if required.
Expand Down Expand Up @@ -4578,4 +4585,4 @@ See [https://discuss.bitrise.io/t/bitrise-api-v0-1-work-in-progress/1554](https:

## Feature / endpoint requests

If you want to request a new API feature / endpoint, please do it here: [http://discuss.bitrise.io/t/bitrise-public-api/37](http://discuss.bitrise.io/t/bitrise-public-api/37)
If you want to request a new API feature / endpoint, please do it here: [http://discuss.bitrise.io/t/bitrise-public-api/37](http://discuss.bitrise.io/t/bitrise-public-api/37)
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Basics of bitrise.yml
menu:
bitrise-cli:
weight: 4

---
A bare minimal `bitrise.yml` is as simple as:

```yaml
Expand Down Expand Up @@ -70,4 +77,4 @@ A quick walk through of this sample configuration:
Read on to learn more about how you can use multiple workflows,
define multiple steps to execute for a given workflow and for
more advanced concepts. You'll be able to define your perfect automation
configuration in no time!
configuration in no time!
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
---
title: bitrise.yml online
menu:
bitrise-cli:
weight: 5

---
Every bitrise.yml file is stored for your builds on [bitrise.io](https://www.bitrise.io). They come in handy when you'd like to check the configuration with which a specific build has run. To do that, you can either use the online `Workflow Editor` or your build's online bitrise.yml file. If you choose the latter, you can compare changes, restore the current build to the original version, edit the config, and download the file to your Mac/PC.


Expand Down Expand Up @@ -61,4 +67,4 @@ You can __edit__ your build config in yml format in the `bitrise.yml editor` if

You can __save__ or __discard__ any changes you have made with the config. If you click `Download currently saved config`, you can __download__ this YML version to your own computer and run it with bitrise CLI on your Mac/PC.

You might want to __clone__ this whole YML configuration or just part of it to another app, so that you can use the copied version as a base and extend it with a few extra steps. All you have to do is copy this bitrise.yml content and paste it into the new app's bitrise.yml editor and develop it further.
You might want to __clone__ this whole YML configuration or just part of it to another app, so that you can use the copied version as a base and extend it with a few extra steps. All you have to do is copy this bitrise.yml content and paste it into the new app's bitrise.yml editor and develop it further.
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Create and share your own Step
menu:
bitrise-cli:
weight: 14

---
Creating your own Step is as simple as running a `bitrise` CLI (v1.6.1+) command and following the guide it prints. You can generate Steps using either the Bash or Go toolkits.

If you don't have the Bitrise CLI installed, check the installation guide [here](/bitrise-cli/installation/).
Expand Down Expand Up @@ -103,4 +110,4 @@ to perform a complete health-check on your forked StepLib.

1. Create a Pull Request in the original StepLib repository.

And that's it, you are done! Once your PR is merged, your step will be available to everyone who uses the StepLib repository you chose.
And that's it, you are done! Once your PR is merged, your step will be available to everyone who uses the StepLib repository you chose.
9 changes: 8 additions & 1 deletion docs/bitrise-cli/index.md → _articles/bitrise-cli/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Intro
menu:
bitrise-cli:
weight: 1

---
Bitrise is a collection of tools and services to help you with the development
and automation of your software projects, with a main focus on mobile apps.

Expand Down Expand Up @@ -81,4 +88,4 @@ __Versioned__: If a new version doesn't work for you, __you can always go back t
_We frequently push features as Steps instead of building it into the core tools.
This allows faster and versioned iterations, and updating the parts independently.
We try to maintain compatibility as much as possible, so older versions can work too,
providing a way to upgrade when it's appropriate for you._
providing a way to upgrade when it's appropriate for you._
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Install and update the Bitrise CLI
menu:
bitrise-cli:
weight: 2

---
Installing the Bitrise CLI is super simple. It is distributed as a single binary which you can acquire in several ways. All you need to do is download it and make it executable. Let's see how!

### Installing the Bitrise CLI with curl
Expand Down Expand Up @@ -37,4 +44,4 @@ If you have the `Homebrew` package manager installed on your Mac, you can use it

Updating the Bitrise CLI is super easy, and it doesn't matter if you installed it with Homebrew or from the GitHub release.
Simply run `bitrise update` - that's it! The CLI checks for updates once every day and notifies you as soon as there is a new version.
Simply run `bitrise update` - that's it! The CLI checks for updates once every day and notifies you as soon as there is a new version.
Loading

0 comments on commit b39cdf0

Please sign in to comment.