doc_log 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +37 -0
- data/lib/doc_log/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e6fdcae75d08484bcc4118be837389fa7cfe52e1
|
|
4
|
+
data.tar.gz: a64e65485664c9c6b064017f965ac6dab51d9e00
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a40bb27a5126c5d8c2689b029d58982d12fa617383ea676f9c983f5eb541b89ca2a467f46305bd357ec969100f87058c15f93b1edce7b5e6229aaf9f3fbd920a
|
|
7
|
+
data.tar.gz: c2ef4324eb48df0220af6c1678eae9ad5d36b5926d05afb50f5b3e26a70ce65957e57dfdd1f1b8d2a91449a64bf3464f9ddc9af57ef0c576450fa571068df5ea
|
data/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# DocLog
|
|
2
|
+
|
|
3
|
+
DocLog allows you to sync your DocRaptor logs to your local environment to allow faster browsing and searching.
|
|
4
|
+
When working in a staging or production environment, you will no longer need to grant all your developers access to your DocRaptor account to be able to view and troubleshoot the generation of their file.
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
Follow these simple steps to install this engine into your application.
|
|
9
|
+
|
|
10
|
+
- Include the gem in your gem file.
|
|
11
|
+
```
|
|
12
|
+
gem 'doc_log'
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
- Mount the engine in your routes file.
|
|
16
|
+
```
|
|
17
|
+
mount DocLog::Engine at: "/doclog"
|
|
18
|
+
```
|
|
19
|
+
As any normal engine, you have several different option when mounting the engine. Please see http://edgeguides.rubyonrails.org/engines.html#mounting-the-engine for more additional information.
|
|
20
|
+
|
|
21
|
+
- Need to create the initializer in the sample application when installing the Engine
|
|
22
|
+
```
|
|
23
|
+
module DocLog
|
|
24
|
+
class Engine < Rails::Engine
|
|
25
|
+
config.api_key = 'yourdocraptorkey'
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
```
|
|
29
|
+
- Schedule the sync through your favorite crontab manager. The sync method can be called via the console as well:
|
|
30
|
+
```
|
|
31
|
+
DocLog::Sync.sync
|
|
32
|
+
```
|
|
33
|
+
- Run a db:migrate to create the table within your database before trying to sync
|
|
34
|
+
|
|
35
|
+
## Contibute
|
|
36
|
+
|
|
37
|
+
Fork the repo, and submit a pull request.
|
data/lib/doc_log/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: doc_log
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
|
-
- Jay
|
|
7
|
+
- Jay Brodie
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
@@ -275,6 +275,7 @@ extensions: []
|
|
|
275
275
|
extra_rdoc_files: []
|
|
276
276
|
files:
|
|
277
277
|
- MIT-LICENSE
|
|
278
|
+
- README.md
|
|
278
279
|
- Rakefile
|
|
279
280
|
- app/assets/javascripts/doc_log/application.js
|
|
280
281
|
- app/assets/javascripts/doc_log/raw_log.js.coffee
|