Commit graph

461 commits

Author SHA1 Message Date
James Baxley
acbfba50ab initial starting point for new docs 2018-04-05 01:24:56 -04:00
Jesse Rosenberger
9ab276576b
Move Docs Renovate configuration into top-level renovate.json.
As determined in
https://github.com/renovateapp/config-help/issues/23#issuecomment-377202632,
it seems that it's not possible to have this sort of inherited
configuration.  It's possible that when I first introduced this behavior
that this behavior was on its way out (and the breaking change in Renovate
v11 on its way in).

Luckily, Renovate's shared configuration option still allows this to be
relatively painless and our `apollo-docs` shared configuration[0] does most
of the heavy lifting here so there won't be too much Renovate toe-stepping.

If this works well in the `apollo-server` repository, I'll transplant this
change to the other docs repositories[1].

[0] https://github.com/apollographql/renovate-config-apollo-docs
[1] https://github.com/meteor/hexo-theme-meteor
2018-03-29 14:33:35 +03:00
Renovate Bot
2c4af9cfd7 chore(deps): update dependency hexo to v3.7.0 2018-03-29 08:01:52 +00:00
Jesse Rosenberger
c9537d30e3 docs: Further standardize format of _config.yml files.
Many of these comments are unhelpful anyway and deserve to be maintained in the
"doc docs" (yes, docs for the docs), which live at https://github.com/apollographql/docs-docs/.
2018-03-23 20:08:31 +02:00
Jesse Rosenberger
7e58334839 docs: Remove api keys which are now set globally by apollo-hexo-config.
These are now defined by https://github.com/apollographql/apollo-hexo-config
and no longer necessary to be individually defined in each deployment.
2018-03-23 20:08:31 +02:00
Jesse Rosenberger
06fc7ee5d4 docs: Remove unnecessary handlebars dependency.
This the reason for this unneeded dependency traces back to the `api-box` on
https://github.com/meteor/docs, though its dependency hasn't been necessary on
any other docs deployment, including this one, since then.
2018-03-23 20:08:31 +02:00
Jesse Rosenberger
7d83875306 docs: Remove lodash, which doesn't seem to have ever been used.
I can't find any evidence in any docs deployment that `lodash` ever needed to
be a direct dependency.  It's possible that this is an artifact that once lived
in an early stage of the docs and just propagated out as a result of making new
docs from old docs repositories.  The `theme-example` application should help
set better precedence for this in the future.
2018-03-23 20:08:31 +02:00
Jesse Rosenberger
9500205e59 docs: Remove develop-theme script, now managed elsewhere.
Rather than developing the theme on individual docs deployments, that work
should now be done on the theme repository[0] and the example doc
deployment[1] since those repositories contain the infrastructure for testing
and deploying changes across all docs properties.  More information on
developing the theme can be found on those repository's `README.md`s.

[0] https://github.com/meteor/hexo-theme-meteor
[1] https://github.com/meteor/theme-example
2018-03-23 20:08:31 +02:00
Jesse Rosenberger
42ae12437d docs: Remove unnecessary showdown dependency.
While I'm aware of the need for the `showdown` package for rendering some
content on the Meteor Docs, I'm not aware of any Apollo repository that uses
it.  I've searched through the source, and cannot find any usage.

If there is a repository that uses it directly (in its `scripts/` directory),
it should be switched to using a plugin, which can explicitly declare
`showdown` as a dependency, rather than depending on it at the root of the
repository. (This is how `hexo-typescript-api-box` does it on the
`apollo-client` docs, which has correctly removed the direct dependency.)

Luckily, these repositories now have tests so if any of these fail, we should
know pretty easily and be able to add the dependency back to just those that
need it.
2018-03-23 20:08:31 +02:00
Jesse Rosenberger
616632ffdb docs: Remove unnecessary hexo-generator-* plugins.
Generators are used for generating additional content in Hexo.  While these
are great for making a blog (for example, `hexo-generator-index` to put all
your blog posts on an index page, `hexo-generator-tag` to keep a page updated
with all your trending blog tags, and `hexo-generator-archive` if you want to
store your aging content somewhere where nobody will find it), they don't seem
to be at all necessary for our purposes, which are documentation.

Unfortunately, they are in the default skeleton of a new Hexo project and they
don't seem to have ever been removed from our non-blog docs deployments,
despite the fact that they seem unnecessary.

In an effort to drastically reduce the overhead of maintaining these docs
deployments, I'm removing these as "unnecessary" until proven otherwise.
2018-03-23 20:08:31 +02:00
Renovate Bot
d9f1db12bd chore(deps): update dependency apollo-hexo-config to v1.0.5 2018-03-22 06:54:24 +00:00
Sashko Stubailo
4cf8200983
Improve related section (#901) 2018-03-21 13:31:46 -07:00
Renovate Bot
ce49ff6132 chore(deps): update dependency meteor-theme-hexo to v1.0.3 2018-03-21 13:10:06 +00:00
Renovate Bot
0e0663d68e chore(deps): update dependency apollo-hexo-config to v1.0.4 2018-03-21 11:25:12 +00:00
Renovate Bot
92d37794d7 chore(deps): update dependency apollo-hexo-config to v1.0.3 2018-03-21 06:24:12 +00:00
renovate[bot]
baf312bb6a chore(deps): update dependency meteor-theme-hexo to v1.0.2 (#892) 2018-03-17 11:18:14 +02:00
renovate[bot]
444ad69f56 chore(deps): update dependency nodemon to v1.17.2 (#889) 2018-03-16 15:49:29 +02:00
Sashko Stubailo
2f80d0680e Update index.md (#883) 2018-03-16 10:46:24 +02:00
Jesse Rosenberger
3a0608ebc5
Tick off Prettier checkmarks, which were present on CI but not locally. (#880)
For reasons unbeknownst to me, the changes below were only being complained
about in the CI environment but _not_ when I ran `npm run lint` locally.

It seems partially related to the OS its ran on, so I imagine there might be
some other sub-dependency at play here.  In an effort to fix this, I just
spawned a Ubuntu docker image, checked out this repository and ran the same
`npm run lint`.  This produced identical results to Travis, so I ran
`npm run lint-fix`, then saved the `git diff` results and have applied this
locally.

This should allow us to re-enable `prettier` in CI, though I have plans to
separate that from the actual `npm test` runs.  This should result in a better
workflow for managing PRs.
2018-03-16 10:25:07 +02:00
Sashko Stubailo
489c418efb
Update example.md 2018-03-15 13:05:32 -07:00
ericvera
d32695824a Fixed the link to the requests doc (#876) 2018-03-13 19:38:01 +02:00
renovate[bot]
84926f137a chore(deps): pin dependencies (#873) 2018-03-13 10:49:28 +02:00
Jesse Rosenberger
fbdcac1a0f
[docs] Use package-based Hexo theme, rather than a Git submodule. (#869)
* docs: Use `devDependencies` instead of `dependencies`.

It's safe to mark all dependencies of this theme as 'dev' dependencies, as
none of them are needed to be installed in a production setting.

This was done automatically, so in some cases, this merges existing
`devDependencies`, and may also have added a missing `nodemon` `devDependency`
in cases where it was missing.  In other cases, this commit may not have
made such a change.

* docs: Remove _config.yml options now covered by global theme config.

* docs: Add `_multiconfig.yml`, a build artifact, to docs `.gitignore`.

* docs: Use theme from npm, rather than submodule, using `chexo`.

The theme which the docs in this repository are based on
([`hexo-theme-meteor`](https://github.com/meteor/hexo-theme-meteor)) has been
published to npm.

Additionally, most of the configuration which was once present in this
repository's `_config.yml` file, has been moved into an Apollo-centric theme
configuration npm,
[`apollo-hexo-config`](https://www.npmjs.com/package/apollo-hexo-config) (and
similarly, [GitHub](https://github.com/apollographql/apollo-hexo-config)).

The theme bundled in this npm is a converged version of the two `apollo`
and `master` branches on the `hexo-theme-meteor` repository, which is a result
of the work undertaken in https://github.com/meteor/hexo-theme-meteor/pull/51.

Lastly, this makes use of a new `chexo` npm which acts as a wrapper for `hexo`
but permits the use of an inherited configuration from npm, rather than a
statically defined CLI file parameter (previously with `--config a,b`).

* docs: Upgrade Hexo generator/tag/server dependencies.

* docs: Add missing `meteor-theme-hexo` package.

This was apparently missed, only on this repository (???) in my automated
commits, probably due to my own error.
2018-03-12 21:13:22 +02:00
Jesse Rosenberger
272f8d27fd
[docs] Update Hexo dependencies for cross-repo consistency. (#815)
* docs: Add npm clean/test 'scripts'.

* docs: Update `hexo` npm to latest version.

* docs: Update `hexo-renderer-ejs` npm to latest version.

* docs: Update `hexo-renderer-marked` npm to latest version.

* docs: Add .nvmrc for use, and as recommended, by Netlify.

* docs: Update additional Hexo dependencies.
2018-02-28 13:22:07 +02:00
Renovate Bot
af673d80a8 fix(deps): update dependency hexo to v3.6.0 2018-02-28 08:16:54 +00:00
Renovate Bot
fbdf2fdf3f fix(deps): update dependency hexo to v3.5.0 2018-01-29 11:03:38 +00:00
Laurin Quast
df51fd90da Setup prettier (#724)
* Setup prettier and precommit hooks

* Format code with prettier

* Use husky because it works...

* Move prettier config to .prettierrc file

* Implement fixing markdown file formatting when running lint-fix script

* Format markdown files

* Add .json file formatting

* Fixes json file formatting

* Add pretteir linting step

* Remove tslint

* Use gitignore for prettier

* Fix linting errors

* Ignore submodule folder
2018-01-08 15:08:01 -08:00
Renovate Bot
7eed00eb15 fix(deps): update dependency hexo to v3.4.4 2017-12-20 08:09:51 +00:00
Sashko Stubailo
b9260bcd13
Update index.md 2017-12-19 10:54:11 -08:00
Sashko Stubailo
fd946941c6
Update index.md 2017-12-19 10:53:07 -08:00
Sashko Stubailo
bfaf238e33
Create README.md 2017-12-19 07:06:48 -08:00
Sashko Stubailo
2f08c74836
Add GitHub link to docs page 2017-12-19 07:05:16 -08:00
Renovate Bot
f9c637b8e1 fix(deps): update dependency hexo-server to ^0.3.0 2017-12-19 08:35:11 +00:00
Sashko Stubailo
d1eed6e2ff Update sidebar link gen to avoid index.html 2017-12-12 21:35:09 -08:00
Renovate Bot
f801c6ca91 fix(deps): update dependency hexo to v3.4.3 2017-12-12 12:25:07 +00:00
Sashko Stubailo
92c61da802 Change tagline 2017-12-12 00:00:59 -08:00
Sashko Stubailo
62158acbd1
Docs improvements round 2 (#693)
* Add 1.0 migration article, belated

* Add tracing + cache control to sidebar

* Suggest graphql-tools

* Link to graphql-tools in README

* Wording

* Try a new title

* Add example to top
2017-12-11 23:44:32 -08:00
Sashko Stubailo
93f052352c
Docs improvements (#692)
* Freshen up title page

* Improve homepage further

* File a PR!

* Try adding express README to sidebar

* Add READMEs to docs

* Add example page, overhaul setup

* More stuff

* Fix all old URLs

* Eliminate all mentions of graphql-server

* Fix azure functions shit
2017-12-11 23:11:11 -08:00
Sashko Stubailo
53ad6351d7 Add Related section, update theme 2017-12-11 21:12:13 -08:00
Sashko Stubailo
4df47fa5e2
Update _config.yml 2017-12-07 23:00:17 -08:00
Imran Sulemanji
5166a36153 Update theme to meteor/hexo-theme-meteor/apollo latest (#683) 2017-12-06 14:02:54 +01:00
renovate[bot]
65e222b479 fix(deps): update dependency hexo to v3.4.0 2017-11-01 08:23:36 +00:00
Martijn Walraven
d6bb52cae2 Update nav logo in docs 2017-10-24 12:35:01 -07:00
Sashko Stubailo
7e0ab3d48d Update theme 2017-10-24 11:07:09 -07:00
renovate[bot]
b1684b4473 fix(deps): update dependency hexo-renderer-marked to v^0.3.0 2017-10-17 18:59:14 +00:00
renovate[bot]
7e5bace230 fix(deps): update dependency hexo-renderer-ejs to v^0.3.0 2017-10-17 18:02:57 +00:00
renovate[bot]
33d9ece9f5 fix(deps): update dependency hexo-generator-index to v^0.2.0 2017-10-17 17:06:36 +00:00
renovate[bot]
0e8027db07 fix(deps): update dependency hexo-generator-tag to v^0.2.0 2017-10-17 15:54:57 +00:00
renovate[bot]
277521716a fix(deps): update dependency hexo to v3.3.9 2017-10-17 14:03:22 +00:00
renovate[bot]
560a8ddf41 fix(deps): update dependency hexo-server to v^0.2.0 2017-10-17 09:09:55 +00:00