Skip to content

Commit

Permalink
Docs reorg (#2339)
Browse files Browse the repository at this point in the history
* start reorg

* reorg of docs for test deploy [NOT READY]

* remove built docs

* update gitignore

* Fix submodule path

* Fix submodule issues
  • Loading branch information
James Baxley authored Oct 19, 2017
1 parent 79f3aae commit be645d1
Show file tree
Hide file tree
Showing 64 changed files with 2,484 additions and 3,569 deletions.
6 changes: 2 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,6 @@ package-lock.json
# docs
db.json
*.log
public/*
!public/_redirects
.deploy*/
docs/public/*
!docs/public/_redirects
.idea/
docs.json
4 changes: 2 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "themes/meteor"]
path = themes/meteor
[submodule "docs/themes/meteor"]
path = docs/themes/meteor
url = https://github.com/meteor/hexo-theme-meteor.git
63 changes: 42 additions & 21 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
## Source: https://github.com/hexojs/hexo/

# Site
title: Apollo Vanilla JS Guide
subtitle: Core API Documentation for the Apollo JS GraphQL Client
description:
title: Apollo Client Guide
propertytitle: Using GraphQL with Apollo Client
subtitle: React Guide
description: A guide to using the Apollo GraphQL Client with React.
author:
language:
timezone:
Expand All @@ -14,25 +15,45 @@ versions:

# This setting also defines the page order used to generate the Previous/Next links at the bottom of each page
sidebar_categories:
# Basics
null:
- index
- apollo-client-api
'Technical Documentation':
- network
- read-and-write
- devtools
- how-it-works
Integrations:
- meteor
- vue
- polymer
- ember
- basics/integrations
- basics/setup
- basics/queries
- basics/mutations
- basics/network-layer
- basics/error-handling
- basics/fragments
- basics/subscriptions
Features:
- features/changelog
- features/caching
- features/developer-tooling
- features/network-customization
- features/optimistic-ui
- features/react-native
- features/static-typing
Recipes:
- recipes/authentication
- recipes/babel
- recipes/meteor
- recipes/pagination
- recipes/prefetching
- recipes/query-splitting
- recipes/server-side-rendering
- recipes/simple-example
- recipes/webpack
# - recipes/client-side-data
# - recipes/using-with-rest
# - recipes/offline
# - recipes/custom-fetching
Reference:
- reference/index

github_repo: apollographql/apollo-client
content_root: source

typescript_api_box:
data_file: docs.json
github_repo: apollographql/apollo-client
content_root: docs/source

social_links:
github: 'https://github.com/apollographql'
Expand All @@ -45,14 +66,14 @@ apis:

# URL
## If your site is put in a subdirectory, set url as 'http://yoursite.com/child' and root as '/child/'
url: https://www.apollographql.com/docs/core
root: /docs/core/
url: https://www.apollographql.com/docs/react
root: /docs/react/
permalink: :year/:month/:day/:title/
permalink_defaults:

# Directory
source_dir: source
public_dir: public/docs/core
public_dir: public/docs/react
tag_dir: tags
archive_dir: archives
category_dir: categories
Expand Down
25 changes: 0 additions & 25 deletions docs/circle.yml

This file was deleted.

15 changes: 3 additions & 12 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,10 @@
"hexo-renderer-ejs": "^0.2.0",
"hexo-renderer-less": "^0.2.0",
"hexo-renderer-marked": "^0.2.4",
"hexo-server": "^0.2.0",
"hexo-typescript-api-box": "0.9.1",
"typedoc": "^0.7.0",
"typescript": "^2.5.3"
},
"devDependencies": {
"hexo-s3-deploy": "^1.2.1"
"hexo-server": "^0.2.0"
},
"scripts": {
"build":
"cd ../packages/apollo-client; typedoc --json ../../docs/docs.json --ignoreCompilerErrors",
"prestart": "npm run build",
"start": "hexo serve",
"deploy": "hexo-s3-deploy"
"build": "hexo generate",
"start": "hexo serve"
}
}
2 changes: 1 addition & 1 deletion docs/public/_redirects
Original file line number Diff line number Diff line change
@@ -1 +1 @@
/ /docs/core
/ /docs/react/
12 changes: 0 additions & 12 deletions docs/react-docs/README.md

This file was deleted.

124 changes: 0 additions & 124 deletions docs/react-docs/_config.yml

This file was deleted.

1 change: 0 additions & 1 deletion docs/react-docs/assets/theme-colors.less

This file was deleted.

26 changes: 0 additions & 26 deletions docs/react-docs/circle.yml

This file was deleted.

32 changes: 0 additions & 32 deletions docs/react-docs/package.json

This file was deleted.

Loading

0 comments on commit be645d1

Please sign in to comment.