From 47b593b43d2584ffdcd64bc0522396129b85664b Mon Sep 17 00:00:00 2001 From: perry Date: Wed, 29 Mar 2017 11:19:31 -0500 Subject: [PATCH] chore(docs): moving docs from `/docs/v2/native` to `/docs/native` --- .github/CONTRIBUTING.md | 2 +- README.md | 4 ++-- scripts/config.json | 4 ++-- scripts/docs/prepare.sh | 2 +- scripts/docs/processors/jekyll.js | 4 ++-- scripts/docs/templates/common.template.html | 2 +- scripts/docs/templates/native_menu.template.html | 4 ++-- scripts/docs/templates/readme.template.md | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8956e377..7dcfe586 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,7 +4,7 @@ #### There are no rules, but here are a few things to consider: ###### Before you submit an issue: * Do a quick search to see if there are similar issues -* Make sure that you are waiting for `deviceready` to fire before interacting with any plugin. If you are using Ionic 2, this can be done using [the `Platform.ready()` function](http://ionicframework.com/docs/v2/api/platform/Platform/#ready). +* Make sure that you are waiting for `deviceready` to fire before interacting with any plugin. If you are using Ionic 2, this can be done using [the `Platform.ready()` function](http://ionicframework.com/docs/api/platform/Platform/#ready). * **Check that you are using the latest version of** `ionic-native`, you can install the latest version by running `npm i --save ionic-native@latest` ###### Still having problems? submit an issue with the following details: diff --git a/README.md b/README.md index bb434928..4f4aebba 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ Run following command to install Ionic Native in your project. npm install @ionic-native/core --save ``` -You also need to install the Ionic Native package for each plugin you want to add. Please see the [Ionic Native documentation](http://ionicframework.com/docs/v2/native/) for complete instructions on how to add and use the plugins. +You also need to install the Ionic Native package for each plugin you want to add. Please see the [Ionic Native documentation](http://ionicframework.com/docs/native/) for complete instructions on how to add and use the plugins. ## Documentation -For the full Ionic Native documentation, please visit [http://ionicframework.com/docs/v2/native/](http://ionicframework.com/docs/v2/native/). +For the full Ionic Native documentation, please visit [http://ionicframework.com/docs/native/](http://ionicframework.com/docs/native/). ### Basic Usage diff --git a/scripts/config.json b/scripts/config.json index b39f8cb9..2008df60 100644 --- a/scripts/config.json +++ b/scripts/config.json @@ -1,6 +1,6 @@ { "sitePath": "../ionic-site", - "v2DocsDir": "docs/v2/native", - "docsDest": "../ionic-site/content/docs/v2/native", + "v2DocsDir": "docs/native", + "docsDest": "../ionic-site/content/docs/native", "pluginDir": "dist/@ionic-native" } diff --git a/scripts/docs/prepare.sh b/scripts/docs/prepare.sh index b7628375..d7a0dde2 100755 --- a/scripts/docs/prepare.sh +++ b/scripts/docs/prepare.sh @@ -30,7 +30,7 @@ function run { git pull origin master fi - git rm -rf content/docs/v2/native/*/ || true + git rm -rf content/docs/native/*/ || true } diff --git a/scripts/docs/processors/jekyll.js b/scripts/docs/processors/jekyll.js index 5c3db7bf..6b889f45 100644 --- a/scripts/docs/processors/jekyll.js +++ b/scripts/docs/processors/jekyll.js @@ -19,7 +19,7 @@ module.exports = function jekyll(renderDocsProcessor) { docs.forEach(doc => { doc.outputPath = doc.outputPath.toLowerCase().replace(/\s/g, '-'); - doc.URL = doc.outputPath.replace('docs/v2//', 'docs/v2/') + doc.URL = doc.outputPath.replace('docs//', 'docs/') .replace('/index.md', '') .replace('content/', ''); }); @@ -29,7 +29,7 @@ module.exports = function jekyll(renderDocsProcessor) { docType: 'nativeMenu', id: 'native_menu', template: 'native_menu.template.html', - outputPath: 'content/_includes/v2_fluid/native_menu.html' + outputPath: 'content/_includes/fluid/native_menu.html' }); return docs; diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 9f64a359..78f1ac8e 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -1,5 +1,5 @@ --- -layout: "v2_fluid/docs_base" +layout: "fluid/docs_base" version: "<$ version.current.name $>" versionHref: "<$ version.current.href.replace('content/','') $>" path: "<$ doc.path $>" diff --git a/scripts/docs/templates/native_menu.template.html b/scripts/docs/templates/native_menu.template.html index d2deb358..2dcd6c16 100644 --- a/scripts/docs/templates/native_menu.template.html +++ b/scripts/docs/templates/native_menu.template.html @@ -1,8 +1,8 @@
  • - Overview + Overview
  • - Browser Usage + Browser Usage
    • <@- for doc in docs @><@ if doc.URL and doc.private != true and doc.beta != true @>
  • diff --git a/scripts/docs/templates/readme.template.md b/scripts/docs/templates/readme.template.md index 44041c23..69fd10d5 100644 --- a/scripts/docs/templates/readme.template.md +++ b/scripts/docs/templates/readme.template.md @@ -20,7 +20,7 @@ $ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add <$ prop.plug $ npm install --save @ionic-native/<$ doc.npmId $> ``` -## [Usage Documentation](https://ionicframework.com/docs/v2/native/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/')|replace('index.ts','')|replace('src/@ionic-native/plugins/','') $>) +## [Usage Documentation](https://ionicframework.com/docs/native/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/')|replace('index.ts','')|replace('src/@ionic-native/plugins/','') $>) Plugin Repo: [<$ prop.repo $>](<$ prop.repo $>)