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
* some updates to the readme for tribal knowledge
* Apply suggestions from code review
Co-authored-by: ruthnaebeck <19349244+ruthnaebeck@users.noreply.github.com>
* more updates
Co-authored-by: ruthnaebeck <19349244+ruthnaebeck@users.noreply.github.com>
|`make start-no-pre-build`| Build the lightweight version of the documentation with no extra content |
30
-
|`make start`| Build the full documentation with all extra content (integrations, extra pulled files, localised content...). Only useful if you have a Github personal token setup in your `Makefile.config` or the extra content is available localy. |
30
+
|`make start`| Build the full documentation with all extra content (integrations, extra pulled files, localized content, etc). Only useful if you have a Github personal token setup in your `Makefile.config` or the extra content is available locally. If you are working with local content, the repo must be downloaded to the same folder as the documentation repo. |
31
31
32
32
**Documentation is then available at `http://localhost:1313`**
33
33
34
-
To learn more about how the documentation is build refer to the [Documentation Build Wiki][7].
34
+
To learn more about how the documentation is built, refer to the [Documentation Build Wiki][7].
35
35
36
36
### Makefile
37
37
38
38
To use the Makefile, create a Makefile.config. See the instructions at the top of the [Makefile.config.example][5].
39
39
40
-
After you have a config file you can run `make help` to see options:
40
+
After you have a config file, run `make help` to see options:
41
41
42
42
```text
43
43
clean-all Clean everything.
@@ -48,7 +48,7 @@ clean-node Remove node_modules.
48
48
clean-virt Remove python virtual env.
49
49
clean Clean all make installs.
50
50
hugpython Build virtualenv used for tests.
51
-
source-helpers Source the helper functions used in build, test, deploy.
51
+
source-helpers Source the helper functions used to build, test, deploy.
52
52
start-no-pre-build Build the documentation without automatically pulled content.
53
53
start Build the documentation with all external content.
* Always branch off of master; never commit directly to master.
62
62
* Name your branch `<SLACK_HANDLE>/<FEATURE_NAME>` if you would like to create a preview site and run tests.
63
63
* When you are ready to commit, create a new pull request to master from your branch.
64
-
* Consult our [contributing guidelines][8] and the [Documentation Build Wiki][7].
64
+
* Consult our [contributing guidelines][8], and the [Documentation Build Wiki][7].
65
65
66
66
### Outside Contributors
67
67
68
68
* Fork the master branch.
69
-
* When you are ready to commit make a pull request back to `DataDog/master`.
69
+
* When you are ready to finalize your changes, commit them, and then make a pull request back to `DataDog/master`.
70
70
* Consult our [contributing guidelines][8].
71
71
72
72
### A note about markdown
73
73
74
-
This site uses [Goldmark][9] for markdown which is compliant with [CommonMark 0.29][10].
74
+
This site uses [Goldmark][9] for markdown, which is compliant with [CommonMark 0.29][10].
75
75
76
76
If you include ANY Markdown in a file, give it an `.md` extension.
77
77
78
-
Make sure all files are lowercase. Macs are case insensitive when creating links to images and pages, but the server is not so tests may be fine locally but the site will fail in production.
78
+
Make sure all files are lowercase. Macs are case insensitive when creating links to images and pages, but our build server is not, so tests may work locally, but the site will fail in production.
79
79
80
80
## Releasing
81
81
82
-
Within 5 minutes of merging to master, it deploys automatically.
82
+
Within 10 minutes of merging to master, it deploys automatically.
0 commit comments