You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Built with [nanoc](http://nanoc.stoneship.org/), a static website generation too
4
4
5
5
## Pre-requisites
6
6
7
-
* Ruby
7
+
* Ruby 2.x.x (if you are using system ruby on OSX, please use rbenv to switch ruby version)
8
8
* RubyGems
9
9
* Bundler
10
10
@@ -36,16 +36,16 @@ This is easy. Are you ready for it? Run this command:
36
36
rake
37
37
```
38
38
*(If you get a message about libnotify or something else, are you a Datadog employee and running on personal chef? Read the note right below Getting started above.)*
39
-
Yeah, that's it. This command will compile the site, check
39
+
Yeah, that's it. This command will compile the site, check
40
40
for any bad links, and refresh your browser.
41
41
42
-
Before you push, make sure you verify there are no bad links.
42
+
Before you push, make sure you verify there are no bad links.
43
43
44
44
**Your final step should be to exit rake, then run ```rake clean``` then ```rake```.**
45
45
46
46
If there are no errors, then and only then push and merge. **If there are errors, please don't merge.** If you have been working on code samples, run ```rake clean``` then ```rake test```. If you didn't work on code samples, don't bother with test.
47
47
48
-
If you are using rake test, you need an environment variable for DD_API_KEY and DD_APP_KEY. These should be for a test account that does not include dozens of people. There are several samples that mute and unmute everything. Everyone in the org will be notified. If you are the only one in the org, you won't be getting angry emails from others asking you to stop muting everything.
48
+
If you are using rake test, you need an environment variable for DD_API_KEY and DD_APP_KEY. These should be for a test account that does not include dozens of people. There are several samples that mute and unmute everything. Everyone in the org will be notified. If you are the only one in the org, you won't be getting angry emails from others asking you to stop muting everything.
49
49
50
50
## How to add a new integration
51
51
@@ -58,7 +58,7 @@ Create a markdown file under content/integratons. Add the following front matter
58
58
doclevel: basic
59
59
---
60
60
61
-
If you are writing a lot about the integration, change doclevel to complete or just remove the whole line. Now write the doc. There is no need to update any index, menu, or sidebars. Those are automatically generated.
61
+
If you are writing a lot about the integration, change doclevel to complete or just remove the whole line. Now write the doc. There is no need to update any index, menu, or sidebars. Those are automatically generated.
62
62
63
63
## How to add a new Guide
64
64
@@ -70,7 +70,7 @@ Create a markdown file under content/guides. Add the following front matter at t
70
70
listorder: <where in the list you want the doc to appear>
71
71
---
72
72
73
-
Each guide has a listorder. Change the list order number of this doc and any other docs to make sure stuff appears in the right order. There is no need to update any index, menu, or sidebars. Those are automatically generated.
73
+
Each guide has a listorder. Change the list order number of this doc and any other docs to make sure stuff appears in the right order. There is no need to update any index, menu, or sidebars. Those are automatically generated.
0 commit comments