Skip to content

Commit

Permalink
docs: Setup documentation deployment
Browse files Browse the repository at this point in the history
This brings the existing documentation and its supporting infrastructure (in
this case, modeled after the Apollo Server repository, but this is standard
"Apollo infrastructure" in the general sense) to the Federation repository
where it can live alongside the code that was migrated over in
#134.

Related: #142
Related: #143
  • Loading branch information
abernix committed Sep 15, 2020
1 parent e151224 commit f4d791c
Show file tree
Hide file tree
Showing 23 changed files with 26,079 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.DS_Store
Thumbs.db
*.log
node_modules/
.deploy*/
.cache
public/
1 change: 1 addition & 0 deletions docs/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
12
29 changes: 29 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Documentation

This is the documentation **source** for this repository.

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

* https://www.apollographql.com/docs/apollo-server/

## Documentation for the documentation

This `README.md` is intentionally short since the [documentation for the documentation](https://docs-docs.netlify.com/docs/docs/) 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.
35 changes: 35 additions & 0 deletions docs/gatsby-config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
const themeOptions = require('gatsby-theme-apollo-docs/theme-options');

module.exports = {
pathPrefix: '/docs/federation',
plugins: [
{
resolve: 'gatsby-theme-apollo-docs',
options: {
...themeOptions,
root: __dirname,
subtitle: 'Apollo Federation',
description: 'A guide to using Apollo Federation',
githubRepo: 'apollographql/federation',
sidebarCategories: {
null: [
'index',
'implementing-services',
'gateway',
'entities',
'value-types',
'errors',
'metrics',
'migrating-from-stitching',
'other-servers',
'federation-spec',
],
'API Reference': [
'api/apollo-federation',
'api/apollo-gateway',
],
},
},
},
],
};
Loading

0 comments on commit f4d791c

Please sign in to comment.