Skip to content

Commit

Permalink
Move docs to flippercloud.io
Browse files Browse the repository at this point in the history
  • Loading branch information
bkeepers committed Nov 12, 2021
1 parent de390c7 commit 68e4b62
Show file tree
Hide file tree
Showing 25 changed files with 13 additions and 2,388 deletions.
2 changes: 1 addition & 1 deletion Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
* Added cloud recommendation to flipper-ui. Can be disabled with `Flipper::UI.configure { |config| config.cloud_recommendation = false }`. Just want to raise awareness that more is available if people want it (https://github.com/jnunemaker/flipper/pull/504)
* Added default `flipper_id` implementation via `Flipper::Identifier` and automatically included it in ActiveRecord and Sequel models (https://github.com/jnunemaker/flipper/pull/505)
* Deprecate superflous sync_method setting (https://github.com/jnunemaker/flipper/pull/511)
* Flipper is now pre-configured when used with Rails. By default, it will [memoize and preload all features for each request](docs/Optimization.md#memoization). (https://github.com/jnunemaker/flipper/pull/506)
* Flipper is now pre-configured when used with Rails. By default, it will [memoize and preload all features for each request](https://flippercloud.io/docs/optimization#memoization). (https://github.com/jnunemaker/flipper/pull/506)

### Upgrading

Expand Down
75 changes: 9 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
[![Flipper Mark](docs/images/banner.jpg)](https://www.flippercloud.io)

[Website](https://flippercloud.io) | [Documentation](https://flippercloud.io/docs) | [Examples](examples) | [Twitter](https://twitter.com/flipper_cloud)

# Flipper

> Beautiful, performant feature flags for Ruby.
Expand Down Expand Up @@ -50,74 +52,25 @@ end

All features are disabled by default, so you'll need to explicitly enable them.

#### Enable a feature for everyone

```ruby
# Enable a feature for everyone
Flipper.enable :search
```

#### Enable a feature for a specific actor

```ruby
# Enable a feature for a specific actor
Flipper.enable_actor :search, current_user
```

#### Enable a feature for a group of actors

First tell Flipper about your groups:

```ruby
# config/initializers/flipper.rb
Flipper.register(:admin) do |actor|
actor.respond_to?(:admin?) && actor.admin?
end
```

Then enable the feature for that group:

```ruby
# Enable a feature for a group of actors
Flipper.enable_group :search, :admin
```

#### Enable a feature for a percentage of actors

```ruby
# Enable a feature for a percentage of actors
Flipper.enable_percentage_of_actors :search, 2
```


Read more about enabling and disabling features with [Gates](docs/Gates.md). Check out the [examples directory](examples/) for more, and take a peek at the [DSL](lib/flipper/dsl.rb) and [Feature](lib/flipper/feature.rb) classes for code/docs.

## Adapters

Flipper is built on adapters for maximum flexibility. Regardless of what data store you are using, Flipper can performantly store data in it.

Pick one of our [supported adapters](docs/Adapters.md#officially-supported) and follow the installation instructions:

* [Active Record](docs/active_record/README.md)
* [Sequel](docs/sequel/README.md)
* [Redis](docs/redis/README.md)
* [Mongo](docs/mongo/README.md)
* [Moneta](docs/moneta/README.md)
* [Rollout](docs/rollout/README.md)

Or [roll your own](docs/Adapters.md#roll-your-own). We even provide automatic (rspec and minitest) tests for you, so you know you've built your custom adapter correctly.

Read more about [Adapters](docs/Adapters.md).

## Flipper UI

If you prefer a web UI to an IRB console, you can setup the [Flipper UI](docs/ui/README.md).

It's simple and pretty.

![Flipper UI Screenshot](docs/ui/images/feature.png)


Read more about [getting started with Flipper](https://flippercloud.io/docs) and [enabling features](https://flippercloud.io/docs/features).

## Flipper Cloud

Or, (even better than OSS + UI) use [Flipper Cloud](https://www.flippercloud.io) which comes with:
Like Flipper and want more? Check out [Flipper Cloud](https://www.flippercloud.io), which comes with:

* **everything in one place** — no need to bounce around from different application UIs or IRB consoles.
* **permissions** — grant access to everyone in your organization or lockdown each project to particular people.
Expand All @@ -131,21 +84,11 @@ Or, (even better than OSS + UI) use [Flipper Cloud](https://www.flippercloud.io)

Cloud is super simple to integrate with Rails ([demo app](https://github.com/fewerandfaster/flipper-rails-demo)), Sinatra or any other framework.

## Advanced

A few miscellaneous docs with more info for the hungry.

* [Instrumentation](docs/Instrumentation.md) - ActiveSupport::Notifications and Statsd
* [Optimization](docs/Optimization.md) - Memoization middleware and Cache adapters
* [API](docs/api/README.md) - HTTP API interface
* [Caveats](docs/Caveats.md) - Flipper beware! (see what I did there)
* [Docker-Compose](docs/DockerCompose.md) - Using docker-compose in contributing

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Run the tests (`bundle exec rake`)
3. Run the tests (`bundle exec rake`). Check out [Docker-Compose](docs/DockerCompose.md) if you need help getting all the adapters running.
4. Commit your changes (`git commit -am 'Added some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create new Pull Request
Expand Down
124 changes: 0 additions & 124 deletions docs/Adapters.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/Caveats.md

This file was deleted.

Loading

0 comments on commit 68e4b62

Please sign in to comment.