apollo-server/docs
Andre Eberhardt b640be4fe6 feature(apollo-engine-reporting): Add custom http agent support (#1879)
This PR fixes #1836.

This PR enables developers to inject the http agent to be used on the network requests to apollo engine endpoint.

<!--
  Thanks for filing a pull request on GraphQL Server!

  Please look at the following checklist to ensure that your PR
  can be accepted quickly:
-->

TODO:

* [x] Update CHANGELOG.md with your change (include reference to issue & this PR)
* [x] Make sure all of the significant new logic is covered by tests
* [x] Rebase your changes on master so that they can be merged easily
* [x] Make sure all tests and linter rules pass

<!--**Pull Request Labels**

While not necessary, you can help organize our pull requests by labeling this issue when you open it.  To add a label automatically, simply [x] mark the appropriate box below:

- [ ] feature
- [ ] blocking
- [ ] docs

To add a label not listed above, simply place `/label another-label-name` on a line by itself.
-->
2018-10-26 20:14:18 +03:00
..
assets Add additional docs files 2017-10-16 17:15:08 -07:00
sketch Apollo Server 2:Automatic Persisted Queries (#1149) 2018-06-11 15:44:20 -07:00
source feature(apollo-engine-reporting): Add custom http agent support (#1879) 2018-10-26 20:14:18 +03:00
.gitignore Start ignoring _redirects again, since it's dynamically generated. 2018-05-01 21:37:16 -07:00
.nvmrc [docs] Update Hexo dependencies for cross-repo consistency. (#815) 2018-02-28 13:22:07 +02:00
_config.yml Cleanup subscriptions link (#1437) 2018-07-27 16:47:34 +02:00
package-lock.json chore(deps): update dependency hexo to v3.8.0 2018-10-19 09:46:12 +00:00
package.json chore(deps): update dependency hexo to v3.8.0 2018-10-19 09:46:12 +00:00
README.md bring version-2 up to date 2018-07-13 13:14:19 -07:00

Documentation

This is the documentation source for this repository.

The deployed version of the documentation for this repository is available at:

Documentation for the documentation

This README.md is intentionally short since the documentation for the documentation provides details for the documentation framework itself. Additional information should generally be added to that documentation rather than here in this README.md, in order to provide a centralized resource that benefits all documentation deployments.

Running locally

For more information, consult the documentation for the documentation, referenced above.

In general though:

  • npm install in this directory
  • npm start in this directory
  • Open a browser to the link provided in the console.

Important note: Changes to the markdown source does not result in an automatic "hot reload" in the browser; it is necessary to reload the page manually in the browser to see it re-rendered. Additionally, changes to _config.yml require stopping the server and restarting with npm start again.

Deploy previews

Documentation repositories should be setup with a "deploy preview" feature which automatically provides "preview" links in the status checks section of pull-requests.

In the event that it's not possible to run the documentation locally, pushing changes to the branch for a pull-request can be a suitable alternative that ensures changes to the documentation are properly rendered.