diff --git a/docs/guides/build-using-too-many-resources.rst b/docs/guides/build-using-too-many-resources.rst new file mode 100644 index 00000000000..68e164f3421 --- /dev/null +++ b/docs/guides/build-using-too-many-resources.rst @@ -0,0 +1,25 @@ +My Build is Using Too Many Resources +==================================== + +We limit build resources to make sure that users don't overwhelm our build systems. +If you are running into this issue, +there are a couple fixes that you might try. + +.. note:: The current build limits can be found on our :doc:`/builds` page. + +Reduce formats you're building +------------------------------ + +You can change the formats of docs that you're building with our YAML file's :ref:`yaml-config:Formats` option. + +In particular, the `htmlzip` takes up a decent amount of memory and time, +so disabling that format might solve your problem. + +Reduce documentation build dependencies +--------------------------------------- + +A lot of projects reuse their requirements file for their documentation builds. +If there are extra packages that you don't need for building docs, +you can create a custom requirements file just for documentation. +This should speed up your documentation builds, +as well as reduce your memory footprint. diff --git a/package.json b/package.json index 8c3b7cf1141..79d2ffe7afe 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,8 @@ "dependencies": { "bowser": "^1.9.3", "cssfilter": "0.0.8", - "github-changelog": "git+https://github.com/agjohnson/github-changelog.git" + "github-changelog": "git+https://github.com/agjohnson/github-changelog.git", + "npm": "^6.1.0" }, "devDependencies": { "bower": "*",