diff --git a/README.md b/README.md index 68907e7e..b19cb8b1 100644 --- a/README.md +++ b/README.md @@ -32,25 +32,10 @@ docpad run --env static Point your browser to: `http://localhost:9778/` -## Deploy +## Deployment -While GitHub Pages is not used to host [fluiproject.org](https://docs.fluidproject.org), our deployment process requires that the generated site be pushed to the `deploy` branch in the project repo. The contents of the `deploy` branch will automatically be served as the contents are changed. - -To generate and push to the `deploy` branch on the project repo run the following: - -```shell -npm run deploy -``` - -This runs the command: - -```shell -docpad deploy-ghpages --env static -``` - -_**WARNING:** Deploying will upload the site to the `deploy` branch of the `origin` remote. If you have cloned -from the production repository and you have push access, you will actually run the docs publication -workflow against the live production branch, regardless of whichever branch you happen to be working on._ +1. Generate the static site: `docpad generate --env static` +2. Commit the contents of `out` directory to the `deploy` branch (we are currently doing this manually, as the plugin we relied on previously is broken); when changes are pushed or merged to the `deploy` branch of the `fluid-project/infusion-docs` repo, CI will pick up and deploy them automatically ## A Note on DocPad plugins diff --git a/docpad.js b/docpad.js index b8a86c45..e5e7732e 100644 --- a/docpad.js +++ b/docpad.js @@ -87,15 +87,6 @@ module.exports = { snippet: "shell", stylus: "css" } - }, - markit: { - html: true, - plugins: ["markdown-it-anchor"], - "markdown-it-anchor": {} - }, - ghpages: { - deployRemote: "origin", - deployBranch: "deploy" } }, events: { diff --git a/package.json b/package.json index ef4341e3..e3de6291 100644 --- a/package.json +++ b/package.json @@ -6,28 +6,27 @@ "repository": "https://github.com/fluid-project/infusion-docs", "scripts": { "docpad": "docpad run --env static --out out", - "deploy": "docpad deploy-ghpages --env static", "pretest": "docpad generate --env static --out out", "test": "node tests/all-tests.js" }, "dependencies": { - "urijs": "1.19.0", - "docpad-plugin-ghpages": "2.6.1", - "docpad-plugin-handlebars": "2.4.0", - "docpad-plugin-highlightjs": "2.5.0", - "docpad-plugin-markit": "2.4.0", - "fs-extra": "4.0.2", - "markdown-it-anchor": "4.0.0" + "docpad": "6.82.5", + "docpad-plugin-handlebars": "github:waharnum/docpad-plugin-handlebars#fixFor6.8-build", + "docpad-plugin-highlightjs": "2.6.0", + "docpad-plugin-marked": "2.5.0", + "docpad-plugin-serve": "2.0.1", + "fs-extra": "7.0.1", + "urijs": "1.19.1" }, "devDependencies": { "eslint-config-fluid": "1.3.0", - "gpii-grunt-lint-all": "1.0.5-dev.20180904T103657Z.c351ca9", - "gpii-express": "1.0.11", - "grunt": "1.0.1", + "gpii-grunt-lint-all": "1.0.5", + "gpii-express": "1.0.15", + "grunt": "1.0.3", "infusion": "3.0.0-dev.20171006T195039Z.a128358", - "jsdom": "11.3.0", - "kettle": "1.7.0", - "node-jqunit": "1.1.7", - "request": "2.83.0" + "jsdom": "13.0.0", + "kettle": "1.9.0", + "node-jqunit": "1.1.8", + "request": "2.88.0" } }