Updated docs api links to be version-less

aileen · aileen · commit d11fd4210b51 · 2019-07-25T15:17:23.000+08:00
diff --git a/.github/ISSUE_TEMPLATE/--anything-else.md b/.github/ISSUE_TEMPLATE/--anything-else.md
@@ -17,8 +17,8 @@ Alternatively, check out these resources below. Thanks! 😁.
 
 - [Forum](https://forum.ghost.org/c/help)
 - [Theme Support](https://forum.ghost.org/c/themes)
-- [Theme Docs](https://ghost.org/docs/api/v2/handlebars-themes/)
-- [API Docs](https://ghost.org/docs/api/v2/)
+- [Theme Docs](https://ghost.org/docs/api/handlebars-themes/)
+- [API Docs](https://ghost.org/docs/api/)
 - [Feature Requests / Ideas](https://forum.ghost.org/c/Ideas)
 - [Contributing Guide](https://ghost.org/docs/concepts/contributing/)
 - [Self-hoster Docs](https://ghost.org/docs/)
diff --git a/README.md b/README.md
@@ -85,7 +85,7 @@ $ ghost install
 
 &nbsp;
 
-Check out our [official documentation](https://ghost.org/docs/) for more information about our [recommended hosting stack](https://ghost.org/docs/concepts/hosting/) & properly [upgrading Ghost](https://ghost.org/faq/upgrade-to-ghost-2-0/), plus everything you need to develop your own Ghost [themes](https://ghost.org/docs/api/v2/handlebars-themes/) or work with [our API](https://ghost.org/docs/api/v2/).
+Check out our [official documentation](https://ghost.org/docs/) for more information about our [recommended hosting stack](https://ghost.org/docs/concepts/hosting/) & properly [upgrading Ghost](https://ghost.org/faq/upgrade-to-ghost-2-0/), plus everything you need to develop your own Ghost [themes](https://ghost.org/docs/api/handlebars-themes/) or work with [our API](https://ghost.org/docs/api/).
 
 &nbsp;
 
diff --git a/content/settings/README.md b/content/settings/README.md
@@ -2,7 +2,7 @@
 
 ### routes.yaml
 
-To find out more about `routes.yaml` configuration and how to use it visit [documentation](https://ghost.org/docs/api/v2/handlebars-themes/routing/).
+To find out more about `routes.yaml` configuration and how to use it visit [documentation](https://ghost.org/docs/api/handlebars-themes/routing/).
 
 This is how the default `routes.yaml` file looks like:
 
diff --git a/core/frontend/helpers/get.js b/core/frontend/helpers/get.js
@@ -223,7 +223,7 @@ module.exports = function getLabsWrapper() {
             // Even though this is a labs enabled helper, really we want users to upgrade to v2 API.
             errMessagePath: 'warnings.helpers.get.apiRequired.message',
             errContextPath: 'warnings.helpers.get.apiRequired.context',
-            helpUrl: 'https://ghost.org/docs/api/v2/handlebars-themes/packagejson/',
+            helpUrl: 'https://ghost.org/docs/api/handlebars-themes/packagejson/',
             async: true
         }, function executeHelper() {
             return get.apply(self, args);
diff --git a/core/frontend/helpers/pagination.js b/core/frontend/helpers/pagination.js
@@ -19,7 +19,7 @@ pagination = function (options) {
         throw new errors.IncorrectUsageError({
             level: 'normal',
             message: i18n.t('warnings.helpers.pagination.invalidData'),
-            help: 'https://ghost.org/docs/api/v2/handlebars-themes/helpers/pagination/'
+            help: 'https://ghost.org/docs/api/handlebars-themes/helpers/pagination/'
         });
     }
 
diff --git a/core/frontend/services/redirects/validation.js b/core/frontend/services/redirects/validation.js
@@ -9,7 +9,7 @@ const validate = (redirects) => {
     if (!_.isArray(redirects)) {
         throw new common.errors.ValidationError({
             message: common.i18n.t('errors.utils.redirectsWrongFormat'),
-            help: 'https://ghost.org/docs/api/v2/handlebars-themes/routing/redirects/'
+            help: 'https://ghost.org/docs/api/handlebars-themes/routing/redirects/'
         });
     }
 
@@ -18,7 +18,7 @@ const validate = (redirects) => {
             throw new common.errors.ValidationError({
                 message: common.i18n.t('errors.utils.redirectsWrongFormat'),
                 context: redirect,
-                help: 'https://ghost.org/docs/api/v2/handlebars-themes/routing/redirects/'
+                help: 'https://ghost.org/docs/api/handlebars-themes/routing/redirects/'
             });
         }
     });
diff --git a/core/server/data/importer/importers/data/index.js b/core/server/data/importer/importers/data/index.js
@@ -59,14 +59,14 @@ DataImporter = {
         if (!importData.meta) {
             throw new common.errors.IncorrectUsageError({
                 message: 'Wrong importer structure. `meta` is missing.',
-                help: 'https://ghost.org/docs/api/v2/migration/#json-file-structure'
+                help: 'https://ghost.org/docs/api/migration/#json-file-structure'
             });
         }
 
         if (!importData.meta.version) {
             throw new common.errors.IncorrectUsageError({
                 message: 'Wrong importer structure. `meta.version` is missing.',
-                help: 'https://ghost.org/docs/api/v2/migration/#json-file-structure'
+                help: 'https://ghost.org/docs/api/migration/#json-file-structure'
             });
         }
 
diff --git a/core/server/data/schema/fixtures/fixtures.json b/core/server/data/schema/fixtures/fixtures.json
diff --git a/core/server/lib/fs/package-json/parse.js b/core/server/lib/fs/package-json/parse.js
@@ -30,7 +30,7 @@ function parsePackageJson(path) {
                 if (!hasRequiredKeys) {
                     err = new Error(common.i18n.t('errors.utils.parsepackagejson.nameOrVersionMissing'));
                     err.context = path;
-                    err.help = common.i18n.t('errors.utils.parsepackagejson.willBeRequired', {url: 'https://ghost.org/docs/api/v2/handlebars-themes/'});
+                    err.help = common.i18n.t('errors.utils.parsepackagejson.willBeRequired', {url: 'https://ghost.org/docs/api/handlebars-themes/'});
 
                     return Promise.reject(err);
                 }
@@ -39,7 +39,7 @@ function parsePackageJson(path) {
             } catch (parseError) {
                 err = new Error(common.i18n.t('errors.utils.parsepackagejson.themeFileIsMalformed'));
                 err.context = path;
-                err.help = common.i18n.t('errors.utils.parsepackagejson.willBeRequired', {url: 'https://ghost.org/docs/api/v2/handlebars-themes/'});
+                err.help = common.i18n.t('errors.utils.parsepackagejson.willBeRequired', {url: 'https://ghost.org/docs/api/handlebars-themes/'});
 
                 return Promise.reject(err);
             }
diff --git a/core/server/services/auth/authorize.js b/core/server/services/auth/authorize.js
@@ -27,7 +27,7 @@ const authorize = {
                     return next(new common.errors.NoPermissionError({
                         message: common.i18n.t('errors.middleware.auth.publicAPIDisabled.error'),
                         context: common.i18n.t('errors.middleware.auth.publicAPIDisabled.context'),
-                        help: common.i18n.t('errors.middleware.auth.forInformationRead', {url: 'https://ghost.org/docs/api/v2/content/'})
+                        help: common.i18n.t('errors.middleware.auth.forInformationRead', {url: 'https://ghost.org/docs/api/content/'})
                     }));
                 }
 
diff --git a/core/server/translations/en.json b/core/server/translations/en.json
@@ -605,7 +605,7 @@
                 "isDeprecated": "Warning: pageUrl is deprecated, please use page_url instead\nThe helper pageUrl has been replaced with page_url in Ghost 0.4.2, and will be removed entirely in Ghost 0.6\nIn your theme's pagination.hbs file, pageUrl should be renamed to page_url"
             },
             "pagination": {
-                "invalidData": "The \\{\\{pagination\\}\\} helper was used outside of a paginated context. See https://ghost.org/docs/api/v2/handlebars-themes/helpers/pagination/.",
+                "invalidData": "The \\{\\{pagination\\}\\} helper was used outside of a paginated context. See https://ghost.org/docs/api/handlebars-themes/helpers/pagination/.",
                 "valuesMustBeDefined": "All values must be defined for page, pages, limit and total",
                 "nextPrevValuesMustBeNumeric": "Invalid value, Next/Prev must be a number",
                 "valuesMustBeNumeric": "Invalid value, check page, pages, limit and total are numbers"
diff --git a/core/server/web/shared/middlewares/custom-redirects.js b/core/server/web/shared/middlewares/custom-redirects.js
@@ -72,7 +72,7 @@ _private.registerRoutes = () => {
             common.logging.error(new common.errors.IncorrectUsageError({
                 message: common.i18n.t('errors.middleware.redirects.register'),
                 context: err.message,
-                help: 'https://ghost.org/docs/api/v2/handlebars-themes/routing/redirects/'
+                help: 'https://ghost.org/docs/api/handlebars-themes/routing/redirects/'
             }));
         }
     }
@@ -82,7 +82,7 @@ _private.registerRoutes = () => {
 
 /**
  * - you can extend Ghost with a custom redirects file
- * - see https://github.com/TryGhost/Ghost/issues/7707 and https://ghost.org/docs/api/v2/handlebars-themes/routing/redirects/
+ * - see https://github.com/TryGhost/Ghost/issues/7707 and https://ghost.org/docs/api/handlebars-themes/routing/redirects/
  * - file loads synchronously, because we need to register the routes before anything else
  */
 exports.use = function use(siteApp) {
diff --git a/core/test/unit/helpers/get_spec.js b/core/test/unit/helpers/get_spec.js
@@ -46,7 +46,7 @@ describe('{{#get}} helper', function () {
                 'string',
                 '<script>console.error("The {{#get}} helper requires your theme to have API access. ' +
                 'Please enable the v2 API via your theme\'s package.json file. ' +
-                'See https://ghost.org/docs/api/v2/handlebars-themes/packagejson/");</script>'
+                'See https://ghost.org/docs/api/handlebars-themes/packagejson/");</script>'
             );
 
             done();
diff --git a/core/test/unit/helpers/pagination_spec.js b/core/test/unit/helpers/pagination_spec.js
@@ -28,7 +28,7 @@ describe('{{pagination}} helper', function () {
             return function () {
                 helpers.pagination.call(data);
             };
-        }, expectedMessage = 'The {{pagination}} helper was used outside of a paginated context. See https://ghost.org/docs/api/v2/handlebars-themes/helpers/pagination/.';
+        }, expectedMessage = 'The {{pagination}} helper was used outside of a paginated context. See https://ghost.org/docs/api/handlebars-themes/helpers/pagination/.';
 
         runHelper('not an object').should.throwError(expectedMessage);
         runHelper(function () {
diff --git a/core/test/unit/lib/fs/package-json/parse_spec.js b/core/test/unit/lib/fs/package-json/parse_spec.js
@@ -45,7 +45,7 @@ describe('lib/fs/package-json: parse', function () {
             .catch(function (err) {
                 err.message.should.equal('"name" or "version" is missing from theme package.json file.');
                 err.context.should.equal(tmpFile.name);
-                err.help.should.equal('This will be required in future. Please see https://ghost.org/docs/api/v2/handlebars-themes/');
+                err.help.should.equal('This will be required in future. Please see https://ghost.org/docs/api/handlebars-themes/');
 
                 done();
             })
@@ -70,7 +70,7 @@ describe('lib/fs/package-json: parse', function () {
             .catch(function (err) {
                 err.message.should.equal('"name" or "version" is missing from theme package.json file.');
                 err.context.should.equal(tmpFile.name);
-                err.help.should.equal('This will be required in future. Please see https://ghost.org/docs/api/v2/handlebars-themes/');
+                err.help.should.equal('This will be required in future. Please see https://ghost.org/docs/api/handlebars-themes/');
 
                 done();
             })
@@ -93,7 +93,7 @@ describe('lib/fs/package-json: parse', function () {
             .catch(function (err) {
                 err.message.should.equal('Theme package.json file is malformed');
                 err.context.should.equal(tmpFile.name);
-                err.help.should.equal('This will be required in future. Please see https://ghost.org/docs/api/v2/handlebars-themes/');
+                err.help.should.equal('This will be required in future. Please see https://ghost.org/docs/api/handlebars-themes/');
 
                 done();
             })
diff --git a/core/test/unit/services/themes/validate_spec.js b/core/test/unit/services/themes/validate_spec.js
@@ -69,7 +69,7 @@ describe('Themes', function () {
                             fatal: true,
                             level: 'error',
                             rule: 'Replace the <code>{{#if author.cover}}</code> helper with <code>{{#if author.cover_image}}</code>',
-                            details: 'The <code>cover</code> attribute was replaced with <code>cover_image</code>.<br>Instead of <code>{{#if author.cover}}</code> you need to use <code>{{#if author.cover_image}}</code>.<br>See the object attributes of <code>author</code> <a href="https://ghost.org/docs/api/v2/handlebars-themes/context/author/#author-object-attributes" target=_blank>here</a>.',
+                            details: 'The <code>cover</code> attribute was replaced with <code>cover_image</code>.<br>Instead of <code>{{#if author.cover}}</code> you need to use <code>{{#if author.cover_image}}</code>.<br>See the object attributes of <code>author</code> <a href="https://ghost.org/docs/api/handlebars-themes/context/author/#author-object-attributes" target=_blank>here</a>.',
                             failures: [{}],
                             code: 'GS001-DEPR-CON-AC'
                         }
@@ -97,7 +97,7 @@ describe('Themes', function () {
                             fatal: true,
                             level: 'error',
                             rule: 'Replace the <code>{{#if author.cover}}</code> helper with <code>{{#if author.cover_image}}</code>',
-                            details: 'The <code>cover</code> attribute was replaced with <code>cover_image</code>.<br>Instead of <code>{{#if author.cover}}</code> you need to use <code>{{#if author.cover_image}}</code>.<br>See the object attributes of <code>author</code> <a href="https://ghost.org/docs/api/v2/handlebars-themes/context/author/#author-object-attributes" target=_blank>here</a>.',
+                            details: 'The <code>cover</code> attribute was replaced with <code>cover_image</code>.<br>Instead of <code>{{#if author.cover}}</code> you need to use <code>{{#if author.cover_image}}</code>.<br>See the object attributes of <code>author</code> <a href="https://ghost.org/docs/api/handlebars-themes/context/author/#author-object-attributes" target=_blank>here</a>.',
                             failures: [{}],
                             code: 'GS001-DEPR-CON-AC'
                         }
diff --git a/core/test/utils/fixtures/export/default_export.json b/core/test/utils/fixtures/export/default_export.json
diff --git a/core/test/utils/fixtures/export/valid.json b/core/test/utils/fixtures/export/valid.json
diff --git a/core/test/utils/fixtures/themes/casper/README.md b/core/test/utils/fixtures/themes/casper/README.md

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ pagination = function (options) {`
`19`	`19`	`throw new errors.IncorrectUsageError({`
`20`	`20`	`level: 'normal',`
`21`	`21`	`message: i18n.t('warnings.helpers.pagination.invalidData'),`
`22`		`- help: 'https://ghost.org/docs/api/v2/handlebars-themes/helpers/pagination/'`
	`22`	`+ help: 'https://ghost.org/docs/api/handlebars-themes/helpers/pagination/'`
`23`	`23`	`});`
`24`	`24`	`}`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ const authorize = {`
`27`	`27`	`return next(new common.errors.NoPermissionError({`
`28`	`28`	`message: common.i18n.t('errors.middleware.auth.publicAPIDisabled.error'),`
`29`	`29`	`context: common.i18n.t('errors.middleware.auth.publicAPIDisabled.context'),`
`30`		`- help: common.i18n.t('errors.middleware.auth.forInformationRead', {url: 'https://ghost.org/docs/api/v2/content/'})`
	`30`	`+ help: common.i18n.t('errors.middleware.auth.forInformationRead', {url: 'https://ghost.org/docs/api/content/'})`
`31`	`31`	`}));`
`32`	`32`	`}`
`33`	`33`