Added TOC and tidy-up readme #190
Conversation
Pull Request Test Coverage Report for Build 10901166898Details
💛 - Coveralls |
| end | ||
| ``` | ||
|
|
||
| If you don't want to check a feature is disabled with `unless`, you can also use `is_disabled?`: |
There was a problem hiding this comment.
Why is this example removed?
There was a problem hiding this comment.
I'm with Gard, I'd like this to stay, it's part of the public API and needs to be surfaced here
There was a problem hiding this comment.
There was no other mention of using unless anywhere in the document, so it felt weird to say "if you don't want to use this thing I never told you about"
There was a problem hiding this comment.
unless is built in to ruby, the example is for is_disabled? usage
| config.url = 'https://unleash.herokuapp.com/api' | ||
| # config.instance_id = "#{Socket.gethostname}" | ||
| config.logger = Rails.logger | ||
| config.custom_http_headers = {'Authorization': '<YOUR_API_TOKEN>'} |
There was a problem hiding this comment.
@alvinometric I think the number/letter list for Initializer works, but perhaps we could add a heading level above the steps, and add a sentence to explain. Something like
### 1. Add Initializer
The initializer setup varies depending on whether you’re using a standard setup, Puma in clustered mode, Phusion Passenger, or Sidekiq.
#### 1.a Initializer for standard Rails applications
#### 1.b Initializer for Puma in clustered mode
#### 1.c Initializer for Phusion Passenger
#### 1.d Initializer for Sidekiq
| Or if you see better fit, only in the controllers that you will be using unleash. | ||
|
|
||
| #### Sample usage | ||
| ### 3. Sample usage |
There was a problem hiding this comment.
I don't think this is section 3, this is general usage for the client
There was a problem hiding this comment.
Right now it's a subsection of the Rails section, that's why it's an h3, but we can make another h2 for general usage
Co-authored-by: Melinda Fekete <[email protected]>
Co-authored-by: Melinda Fekete <[email protected]>
Good call, added 🙏 |
6 participants
This is to make sure others don't miss the Rails instructions, like I did (and apparently many of customers still do)
@melindafekete I added
1.a,1.b, etc to show that there are different options, but happy to hear another idea