Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs #39

Merged
merged 1 commit into from
Oct 17, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion _config.yml

This file was deleted.

Empty file added docs/.nojekyll
Empty file.
29 changes: 29 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Flagr Quickstart Guide

Flagr delivers the right experience to the right entity and monitors the impact. It’s a micro service that provides the functionality of feature flags, experimentation (A/B testing), and dynamic configuration.

## Install from Source

Source installation is only intended for developers and advanced users.

```sh
# get the source
go get -u github.com/checkr/flagr
cd $GOPATH/src/github.com/checkr/flagr

# docker-compose with the infra
docker-compose up

# install dependencies, generated code, and run the app
make all
```

## Test using Flagr UI
Flagr Server comes with an embedded web based UI. Point your web browser to http://127.0.0.1:18000 ensure your server has started successfully.

## Explore Further
- [Flagr QuickStart Guide]()
- [Flagr Documentation Website]()

## Contribute to Flagr Project
Please follow Flagr [Contributor's Guide](https://github.com/checkr/flagr/blob/master/CONTRIBUTING.md)
21 changes: 21 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
</body>
<script>
window.$docsify = {
name: '',
repo: ''
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</html>
24 changes: 24 additions & 0 deletions swagger/index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,30 @@ info:
description: Flagr is a feature flagging, A/B testing and dynamic configuration microservice
title: Flagr
version: 1.0.0
tags:
- name: flag
description: Everything about the flag
- name: segment
description: Segment defines the audience of the flag, it's the user segmentation
- name: constraint
description: Constraint is the unit of defining a small subset of users
- name: distribution
description: Distribution is the percent distribution of variants within that segment
- name: variant
description: Variants are the possible outcomes of flag evaluation
- name: evaluation
description: Evaluation is the process of evaluating a flag given the entity context
x-tagGroups:
- name: Flag Management
tags:
- flag
- segment
- constraint
- distribution
- variant
- name: Flag Evaluation
tags:
- evaluation
consumes:
- application/json
produces:
Expand Down
46 changes: 45 additions & 1 deletion swagger_gen/restapi/embedded_spec.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.