[WIP] Pull LoopBack 4 doc updates from loopback-next

.travis.yml

@@ -0,0 +1,22 @@
+language: node_js
+node_js:
+  - "8"
+
+os:
+  - linux
+
+deploy:
+  provider: pages
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  keep-history: true
+  on:
+    branch: gh-pages
+  script:
+    - /bin/bash ./update-readmes.sh
+    - /bin/bash ./update-community-readmes.sh
+    - /bin/bash ./update-v4-readmes.sh
+    - npm test
+  email: [email protected]
+  name: StrongLoop Bot
+

Gemfile

@@ -4,3 +4,4 @@ gem 'rouge'
 gem 'github-pages'
 gem 'jekyll'
 gem 'jekyll-redirect-from'
+gem 'jekyll-relative-links'

Gemfile.lock

@@ -217,7 +217,8 @@ DEPENDENCIES
   github-pages
   jekyll
   jekyll-redirect-from
+  jekyll-relative-links
   rouge
 
 BUNDLED WITH
-   1.15.1
+   1.16.0

README.md

@@ -70,6 +70,17 @@ summary: A brief tutorial on creating an Angular client app using the Loopback A
 {% include readmes/loopback-example-angular.md %}
 ```
 
+## Incorporating updates from loopback-next
+
+We use a node script `update-lb4-docs` to copy over contents from loopback-next
+repository using `@loopback/docs` package. The script is responsible for copying
+over the markdown documentation and related tables, as well as the sidebar used
+for LoopBack 4 content. The changes are then picked up as part of Travis CI's
+builds along with README update scripts and deployed to GitHub Pages once
+successful. The `upgrade-swagger-ui.js` script is also run as part of the
+builds. If you'd like to make documentation changes for LoopBack 4, please do so
+on its own [repository](https://github.com/strongloop/loopback-next/).
+
 ### Linting Readmes
 
 There is an additional `npm script` that "lints" the readmes for markdown formatting problems. It is currently "experimental", see [this issue](https://github.com/strongloop/loopback.io/issues/49#issuecomment-253672668) for more info.

_config.yml

@@ -8,6 +8,7 @@ whitelist:
 
 plugins:
   - jekyll-redirect-from
+  - jekyll-relative-links
 
 topnav_title: LoopBack
 # this appears on the top navigation bar next to the home button
@@ -21,6 +22,8 @@ company_name: IBM / StrongLoop
 github_editme_path: strongloop/loopback.io/blob/gh-pages/pages
 # if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
 
+lb4_editme_path: strongloop/loopback-next/blob/master/docs/site
+
 google_analytics: UA-102515604-1
 
 disqus_shortname:
@@ -38,6 +41,7 @@ exclude:
   - node_modules
   - Jenkinsfile
   - update-readmes.sh
+  - update-v4-readmes.sh
 # these are the files and directories that jekyll will exclude from the build
 
 feedback_email: [email protected]

_layouts/page.html

@@ -8,8 +8,12 @@
 {% endif %}
 <div class="post-header">
    <h1 class="post-title-main">{{ page.title }}</h1>
-   {% if site.github_editme_path and page.layout != 'readme' %}
-       {% assign edit_url =  page.url | remove: "/doc" | remove: ".html" | append: ".md" | prepend: site.github_editme_path %}
+   {% if site.github_editme_path and page.layout != 'readme' and page.sidebar != 'lb4_sidebar' %}
+     {% assign edit_url =  page.url | remove: "/doc" | remove: ".html" | append: ".md" | prepend: site.github_editme_path %}
+       <a target="_blank" href="https://github.com/{{edit_url}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit this page</a>
+   {% endif %}
+   {% if site.lb4_editme_path and page.layout != 'readme' and page.sidebar == 'lb4_sidebar' %}
+     {% assign edit_url =  page.url | remove: "doc/en/lb4" | remove: ".html" | append: ".md" | prepend: site.lb4_editme_path %}
        <a target="_blank" href="https://github.com/{{edit_url}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit this page</a>
    {% endif %}
 </div>

package.json

@@ -6,7 +6,9 @@
     "start": "bundle exec jekyll serve --incremental",
     "fetch-readmes": "get-readmes --repos=./_data --out=./_includes/readmes",
     "lint-readmes": "markdownlint _includes/readmes/",
-    "postinstall": "node ./api-explorer/upgrade-swagger-ui.js"
+    "postinstall": "npm run swagger-ui && npm run copydocs",
+    "swagger-ui": "node ./api-explorer/upgrade-swagger-ui.js",
+    "copydocs": "node update-lb4-docs.js"
   },
   "engines": {
     "node": ">=8"
@@ -17,6 +19,7 @@
   },
   "devDependencies": {
     "fs-extra": "^5.0.0",
+    "@loopback/docs": "latest",
     "getreadmes": "github:strongloop/get-readmes",
     "markdownlint-cli": "github:sequoia/markdownlint-cli",
     "swagger-ui-dist": "^3.4.4"

update-lb4-docs.js

@@ -0,0 +1,61 @@
+const fs = require('fs-extra');
+const path = require('path');
+
+const srcDocs = path.resolve(__dirname,'node_modules/@loopback/docs/site');
+const destDocs = path.resolve(__dirname, 'pages/en/lb4');
+const srcSidebars = path.resolve(srcDocs, 'sidebars');
+const destSidebars= path.resolve(__dirname, '_data/sidebars');
+
+/**
+ * Utility function to remove a directory.
+ * @param {string} dir - The path of the directory to remove.
+ */
+function removeDir(dir) {
+  try {
+    fs.removeSync(dir);
+  } catch (err) {
+    console.error('failed to cleanup %s due to %s',
+      dir, err.stack);
+    process.exit(1);
+  }
+}
+/**
+ * Utility function to copy contents of a source directory to
+ * a target directory. If certain files already exist, it will
+ * overwrite them.
+ * @param {string} src - The path of the source directory to copy from.
+ * @param {string} dest - The path of the target directory to copy to.
+ */
+function copyDocs(src, dest) {
+  try {
+    fs.copySync(src, dest, {overwrite: true});
+  } catch (err) {
+    console.error('failed to copy latest docs %s from %s', src, err.stack);
+    process.exit(1);
+  }
+}
+
+// copy the latest docs from @loopback/docs to pages/en/lb4 directory
+copyDocs(srcDocs, destDocs);
+
+//copy over sidebar for LoopBack 4
+copyDocs(srcSidebars, destSidebars);
+
+//clean up sidebar dir
+removeDir(srcSidebars);
+
+
+
+const fileToUpdate = path.resolve(destDocs, 'Testing-the-API.md');
+
+// bug in `jekyll-relative-links` plugin; probably safe to remove when
+// https://github.com/benbalter/jekyll-relative-links/issues/5
+// is resolved
+try {
+  let contents = fs.readFileSync(fileToUpdate, 'utf-8');
+  contents = contents.replace('include previous.md', 'include previous.html');
+  fs.writeFileSync(fileToUpdate, contents, 'utf-8');
+} catch (err) {
+  console.error('failed to replace relative link %s', err.stack);
+  process.exit(1);
+}