Adding version warnings to any versioned doc w/ deprecated Lock/Auth0.js

Jeff Smith · Jeff Smith · commit 433161e3ae22 · 2018-02-12T10:17:33.000-05:00
diff --git a/articles/_includes/_lock-sdk.html b/articles/_includes/_lock-sdk.html
@@ -1,6 +1,6 @@
 
-<% if (meta.path !== "articles/libraries/lock/v10") { %>
-  <p>For more information on using Lock <a href="/libraries/lock">see the documentation.</a></p>
+<% if (meta.path !== "articles/libraries/lock/v11") { %>
+  <p>For more information on using Lock v11 <a href="/libraries/lock">see the documentation.</a></p>
 <% } %>
 <div class="code-picker">
   <div class="languages-bar">
diff --git a/articles/_includes/_version_warning_auth0js.md b/articles/_includes/_version_warning_auth0js.md
@@ -0,0 +1,3 @@
+::: version-warning
+This document covers a deprecated version of Auth0.js. We recommend that you [migrate to Auth0.js](/libraries/auth0js/v9/migration-guide) as soon as possible.
+:::
diff --git a/articles/_includes/_version_warning_lock.md b/articles/_includes/_version_warning_lock.md
@@ -0,0 +1,3 @@
+::: version-warning
+This document covers a deprecated version of Lock. We recommend that you [migrate to Lock v11](/libraries/lock/v11/migration-guide) as soon as possible.
+:::
diff --git a/articles/connections/passwordless/regular-web-app-email-code/v7/index.md b/articles/connections/passwordless/regular-web-app-email-code/v7/index.md
@@ -54,6 +54,8 @@ You can follow any of the [Regular Web App Quickstarts](/quickstart/webapp) to s
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 You can perform passwordless authentication in your regular web app with your own custom UI using the [Auth0 JavaScript client library](/libraries/auth0js/v7).
 
 <%= include('../../_init-auth0js', {withCallbackURL:true} ) %>
diff --git a/articles/connections/passwordless/regular-web-app-email-code/v8/index.md b/articles/connections/passwordless/regular-web-app-email-code/v8/index.md
@@ -52,6 +52,8 @@ You can follow any of the [Regular Web App Quickstarts](/quickstart/webapp) to s
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 <%= include('../../../../_includes/_package', {
   org: 'auth0-samples',
   repo: 'auth0-node-passwordless-sample',
diff --git a/articles/connections/passwordless/regular-web-app-email-link/v7/index.md b/articles/connections/passwordless/regular-web-app-email-link/v7/index.md
@@ -46,6 +46,8 @@ You can follow any of the [Regular Web App Quickstarts](/quickstart/webapp) to s
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 You can perform passwordless authentication in your regular web app with your own custom UI using the [Auth0 JavaScript client library](/libraries/auth0js/v7).
 
 <%= include('../../_init-auth0js', {withCallbackURL:true} ) %>
diff --git a/articles/connections/passwordless/regular-web-app-email-link/v8/index.md b/articles/connections/passwordless/regular-web-app-email-link/v8/index.md
@@ -44,6 +44,8 @@ You can follow any of the [Regular Web App Quickstarts](/quickstart/webapp) to s
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 <%= include('../../../../_includes/_package', {
   org: 'auth0-samples',
   repo: 'auth0-node-passwordless-sample',
diff --git a/articles/connections/passwordless/regular-web-app-sms/v7/index.md b/articles/connections/passwordless/regular-web-app-sms/v7/index.md
@@ -56,6 +56,8 @@ You can follow any of the [Regular Web App Quickstarts](/quickstart/webapp) to s
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 You can perform passwordless authentication in your regular web app with your own custom UI using the [Auth0 JavaScript client library](/libraries/auth0js/v7).
 
 <%= include('../../_init-auth0js', {withCallbackURL:true} ) %>
diff --git a/articles/connections/passwordless/regular-web-app-sms/v8/index.md b/articles/connections/passwordless/regular-web-app-sms/v8/index.md
@@ -55,6 +55,8 @@ You can follow any of the [Regular Web App Quickstarts](/quickstart/webapp) to s
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 <%= include('../../../../_includes/_package', {
   org: 'auth0-samples',
   repo: 'auth0-node-passwordless-sample',
diff --git a/articles/connections/passwordless/spa-email-code/v7/index.md b/articles/connections/passwordless/spa-email-code/v7/index.md
@@ -57,6 +57,8 @@ Once the user enters the code received by email, Lock will authenticate them and
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 You can perform passwordless authentication in your SPA with your own custom UI using the [Auth0 JavaScript client library](/libraries/auth0js/v7).
 
 <%= include('../../_init-auth0js', {withCallbackURL:false} ) %>
diff --git a/articles/connections/passwordless/spa-email-code/v8/index.md b/articles/connections/passwordless/spa-email-code/v8/index.md
@@ -56,6 +56,8 @@ Once the user enters the code received by email, Lock will trigger the `authenti
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 <%= include('../../../../_includes/_package', {
   org: 'auth0-samples',
   repo: 'auth0-jquery-passwordless-sample',
diff --git a/articles/connections/passwordless/spa-email-link/v7/index.md b/articles/connections/passwordless/spa-email-link/v7/index.md
@@ -60,6 +60,8 @@ $(document).ready(function(){
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 You can perform passwordless authentication with a magic link in your single-page application using your own UI with the [Auth0 JavaScript client library](/libraries/auth0js/v7).
 
 <%= include('../../_init-auth0js', {withCallbackURL:false} ) %>
diff --git a/articles/connections/passwordless/spa-email-link/v8/index.md b/articles/connections/passwordless/spa-email-link/v8/index.md
@@ -62,6 +62,8 @@ You can follow any of the [Single Page App Quickstarts](/quickstart/spa) to see
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 <%= include('../../../../_includes/_package', {
   org: 'auth0-samples',
   repo: 'auth0-jquery-passwordless-sample',
diff --git a/articles/connections/passwordless/spa-sms/v7/index.md b/articles/connections/passwordless/spa-sms/v7/index.md
@@ -61,6 +61,8 @@ If the code is correct, the user will be authenticated. This will call the callb
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 You can perform passwordless authentication in your SPA with your own custom UI using the [Auth0 JavaScript client library](/libraries/auth0js/v7).
 
 <%= include('../../_init-auth0js', {withCallbackURL:false} ) %>
diff --git a/articles/connections/passwordless/spa-sms/v8/index.md b/articles/connections/passwordless/spa-sms/v8/index.md
@@ -51,6 +51,8 @@ If the code is correct, the user will be authenticated. This will trigger the `a
 
 ### Use your own UI
 
+<%= include('../../../../_includes/_version_warning_auth0js') %>
+
 <%= include('../../../../_includes/_package', {
   org: 'auth0-samples',
   repo: 'auth0-jquery-passwordless-sample',
diff --git a/articles/libraries/auth0js/v7/index.md b/articles/libraries/auth0js/v7/index.md
@@ -6,9 +6,7 @@ description: How to install, initialize and use auth0.js v7
 
 # Auth0.js v7 Reference
 
-::: version-warning
-This document covers an outdated version of auth0.js. We recommend you to <a href="/libraries/auth0js">upgrade to v9</a>.
-:::
+<%= include('../../../_includes/_version_warning_auth0js') %>
 
 Auth0.js is a client-side library for [Auth0](http://auth0.com), for use in your web apps. It allows you to trigger the authentication process and parse the [JSON Web Token](http://openid.net/specs/draft-jones-json-web-token-07.html) (JWT) with just the Auth0 `clientID`. Once you have the JWT, you can use it to authenticate requests to your HTTP API and validate the JWT in your server-side logic with the `clientSecret`.
 
diff --git a/articles/libraries/auth0js/v8/index.md b/articles/libraries/auth0js/v8/index.md
@@ -5,6 +5,8 @@ description: How to install, initialize and use auth0.js v8
 ---
 # Auth0.js v8 Reference
 
+<%= include('../../../_includes/_version_warning_auth0js') %>
+
 Auth0.js is a client-side library for Auth0. Using auth0.js in your web apps makes it easier to do authentication and authorization with Auth0 in your web apps.
 
 ::: note
diff --git a/articles/libraries/lock/_includes/_lock-version-9.md b/articles/libraries/lock/_includes/_lock-version-9.md
diff --git a/articles/libraries/lock/_includes/_lock-version.md b/articles/libraries/lock/_includes/_lock-version.md
diff --git a/articles/libraries/lock/v10/api.md b/articles/libraries/lock/v10/api.md
@@ -5,6 +5,8 @@ description: Details on the Lock V10 API.
 ---
 # Lock: API Reference
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 Lock has many methods, features, and configurable options. This reference is designed to direct you to the ones that you need, and discuss how to use them. Click below to go straight the method you're looking for, or just browse! If you're looking for information about events emitted by Lock, they're listed under the [on()](#on-event-callback-) method section!
 
 - [new Auth0Lock](#auth0lock) - Instantiating Lock
diff --git a/articles/libraries/lock/v10/auth0js.md b/articles/libraries/lock/v10/auth0js.md
@@ -4,6 +4,8 @@ description: How to use Lock v10 with auth0.js
 ---
 # Using Lock With auth0.js
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 By nature, Lock and the Auth0.js SDK are different things. Lock provides a UI that is customizable (to an extent) with behavior that is customizable (to an extent). It is an easily deployed, easily used interface for Auth0 authentication in custom applications. It is also easily used within the Auth0 [Hosted Login Page](/hosted-pages/login).
 
 For simple uses, Lock is all that is necessary. However, while using Lock, if more customization is required in an application than Lock allows, functionality from the Auth0.js SDK can be used alongside Lock to meet those needs. An example might be using Lock to handle signups and logins, while using auth0.js to [manage users](/libraries/auth0js#user-management) (read and update user metadata, link user accounts together, and similar tasks).
diff --git a/articles/libraries/lock/v10/authentication-modes.md b/articles/libraries/lock/v10/authentication-modes.md
@@ -5,6 +5,8 @@ toc: true
 ---
 # Lock: Authentication Modes
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 Lock can function in two different modes. The default mode is **redirect mode**. In this mode, your user is redirected to be authenticated, and then is returned to the application. In the second mode, **popup mode**, a popup window allows the user to authenticate with the identity provider without leaving the application.
 
 ## Redirect Mode
diff --git a/articles/libraries/lock/v10/configuration.md b/articles/libraries/lock/v10/configuration.md
@@ -5,6 +5,8 @@ description: Lock 10 has many configurable options that allow you to change the
 ---
 # Lock: Configuration Options
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 The **Auth0Lock** can be configured through the `options` parameter sent to the constructor. These options can alter the way that the Lock widget behaves, how it deals with connections, additional signup fields that you require for your project, the language and text values, colors, and images on the widget, and many more. Take a look at the index below if you know what you are looking for, or browse the options for more details.
 
 ```js
diff --git a/articles/libraries/lock/v10/customizing-error-messages.md b/articles/libraries/lock/v10/customizing-error-messages.md
@@ -4,6 +4,8 @@ description: Customizing error messages with Lock 10
 ---
 # Lock: Customizing Error Messages
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 You can customize the error messages that will be displayed in certain situations by providing a [languageDictionary option](/libraries/lock/v10/customization#languagedictionary-object-). A full listing of available `languageDictionary` fields to customize can be found in the GitHub repository's [English Dictionary file for Lock 10](https://github.com/auth0/lock/blob/master/src/i18n/en.js). Below is an example of some customized error messages:
 
 ```js
diff --git a/articles/libraries/lock/v10/i18n.md b/articles/libraries/lock/v10/i18n.md
@@ -4,6 +4,8 @@ description: Lock 10 supports multiple languages, and allows for the addition of
 ---
 # Lock: Internationalization
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 You can change the language of Lock by using the `language` configuration option. This will pull the corresponding language file from the `i18n` directory in Lock. Take a look at that [i18n directory](https://github.com/auth0/lock/blob/master/src/i18n/) for a current list of provided languages.
 
 In order to use the below examples, you'll need to first include Lock in your page:
diff --git a/articles/libraries/lock/v10/index.md b/articles/libraries/lock/v10/index.md
@@ -7,6 +7,8 @@ img: media/articles/libraries/lock-web.png
 ---
 # Lock 10 for Web
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 Lock is an embeddable login form, [configurable to your needs][lock-configuration] and ready for use on web apps. It enables you to easily add social identity providers to Lock, allowing your users to login seamlessly using any provider they want.
 
 ::: note
@@ -127,8 +129,6 @@ Browser compatibility is ensured for **Chrome**, **Safari**, **Firefox** and **I
 
 The below widget displays brief examples of implementing Auth0 in several ways: Lock as a modal "popup" widget, Lock embedded inline in a div, Lock Passwordless, a custom UI with [Auth0.js](/libraries/auth0js), and a simple link using the API.
 
-<%= include('../../../_includes/_lock-sdk') %>
-
 ## Next Steps
 
 This document has shown how to use Lock 10 within a Single Page Application (SPA). Take a look at the following resources to see how Lock can be used with other kinds of web apps, or how it can be customized for your needs:
diff --git a/articles/libraries/lock/v10/new-features.md b/articles/libraries/lock/v10/new-features.md
@@ -4,6 +4,8 @@ description: Describes the new features with Lock V10.
 ---
 # New Features in Lock 10
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 ## Custom Sign Up Fields
 
 You can add input fields to the sign up form with the new option `additionalSignUpFields`.
diff --git a/articles/libraries/lock/v10/selecting-the-connection-for-multiple-logins.md b/articles/libraries/lock/v10/selecting-the-connection-for-multiple-logins.md
@@ -4,6 +4,8 @@ description: How to select different connection types for multiple login options
 ---
 # Selecting the Connection in Lock
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 Auth0 allows you to offer your users multiple ways of authenticating. This is especially important with SaaS, multi-tenant apps, in which a single app is used by many different organizations, each one of which is potentially using different systems such as LDAP, Active Directory, Google Apps, or username/password stores.
 
 ![](/media/articles/hrd/sd4h-6wlwOsQA1PCQKLAmtQ.png)
diff --git a/articles/libraries/lock/v10/sending-authentication-parameters.md b/articles/libraries/lock/v10/sending-authentication-parameters.md
@@ -4,6 +4,8 @@ description: Lock V10 documentation on setting authentication parameters.
 ---
 # Lock: Authentication Parameters
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 You can send parameters when starting a login by adding them to the options object. The example below adds a `state` parameter with a value equal to `'foo'`.
 
 ```js
diff --git a/articles/libraries/lock/v10/ui-customization.md b/articles/libraries/lock/v10/ui-customization.md
@@ -4,6 +4,8 @@ description: Customizing the appearance of your Lock widget can be important for
 ---
 # Lock: UI Customization
 
+<%= include('../../../_includes/_version_warning_lock') %>
+
 You can customize the appearance of your Lock widget in a few different ways. The best and safest way to do so is with the provided JavaScript options.
 
 ## JavaScript Options
diff --git a/articles/libraries/lock/v9/api.md b/articles/libraries/lock/v9/api.md
@@ -6,7 +6,7 @@ toc: true
 ---
 # Lock 9: API Reference
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 ## Methods
 
diff --git a/articles/libraries/lock/v9/authentication-modes.md b/articles/libraries/lock/v9/authentication-modes.md
@@ -5,7 +5,7 @@ toc: true
 ---
 # Lock: Authentication Modes
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 After Auth0 Lock is opened, you can choose any of the Identity Providers (IdP) that Auth0 has, to Login. Depending on how the IdP Web/App is opened, a different authentication mode is used.
 
diff --git a/articles/libraries/lock/v9/configuration.md b/articles/libraries/lock/v9/configuration.md
@@ -4,7 +4,7 @@ description: How to configure user options with Lock V9
 ---
 # Lock: User configurable options
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 The **Auth0Lock** can be customized through the `options` parameter sent to the `.show()` methods.
 
diff --git a/articles/libraries/lock/v9/customizing-error-messages.md b/articles/libraries/lock/v9/customizing-error-messages.md
@@ -4,7 +4,7 @@ description: Customizing error messages with Lock V9
 ---
 # Lock: Customizing Error Messages
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 You can customize the error messages that will be displayed on certain situations by providing a [dict option](/libraries/lock/v9/customization#dict-object) at the [customization options](/libraries/lock/v9/customization). A full listing of available `dict` fields to customize can be found in the GitHub repository's [English Dictionary file for Lock 9](https://github.com/auth0/lock/blob/v9/i18n/en.json). Below is an example of some customized error messages:
 
diff --git a/articles/libraries/lock/v9/i18n.md b/articles/libraries/lock/v9/i18n.md
@@ -4,7 +4,7 @@ description: Lock V9 internationalization
 ---
 # Lock: Internationalization
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 You can call instantiate the widget with the `dict` option:
 
diff --git a/articles/libraries/lock/v9/index.md b/articles/libraries/lock/v9/index.md
@@ -6,7 +6,7 @@ toc: true
 ---
 # Lock 9 for Web
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 ![Lock Image](/media/articles/libraries/lock/v9/lock-landing.png)
 
diff --git a/articles/libraries/lock/v9/migration-guide.md b/articles/libraries/lock/v9/migration-guide.md
@@ -4,7 +4,7 @@ description: Guide to migrate from Auth0 Widget to Auth0 Lock.
 ---
 # Lock: Migration Guide
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 This guide will walk you through the needed changes to migrate from **Auth0Widget** to **Auth0Lock**.
 
diff --git a/articles/libraries/lock/v9/selecting-the-connection-for-multiple-logins.md b/articles/libraries/lock/v9/selecting-the-connection-for-multiple-logins.md
@@ -4,7 +4,7 @@ description: Describes different options for selecting the connection in Auth0 w
 ---
 # Selecting the connection in Auth0 for multiple login options
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 Auth0 allows you to offer your users multiple ways of authenticating. This is especially important with SaaS, multitenant apps in which a single app is used by many different organizations, each one potentially using different systems: LDAP, Active Directory, Google Apps, or username/password stores.
 
diff --git a/articles/libraries/lock/v9/sending-authentication-parameters.md b/articles/libraries/lock/v9/sending-authentication-parameters.md
@@ -4,7 +4,7 @@ description: Supported parameters that can be used with Lock V9.
 ---
 # Lock: Authentication Parameters
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 You can send parameters when starting a login by adding them to the options object. The example below adds a `state` parameter with a value equal to `'foo'`.
 
diff --git a/articles/libraries/lock/v9/ui-customization.md b/articles/libraries/lock/v9/ui-customization.md
@@ -4,7 +4,7 @@ description: Customizing how Lock with CSS and Javascript
 ---
 # Lock: Customize the look and feel
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 You can apply your own styles to the elements of the Lock.
 
diff --git a/articles/libraries/lock/v9/using-a-refresh-token.md b/articles/libraries/lock/v9/using-a-refresh-token.md
@@ -4,7 +4,7 @@ description: Getting and using a Refresh Token with Lock.
 ---
 # Lock: Refresh Tokens
 
-<%= include('../_includes/_lock-version-9') %>
+<%= include('../../../_includes/_version_warning_lock') %>
 
 Mostly when building mobile apps, we want to show the signin page only once and then leave the user logged in forever. For those cases, it makes sense to have a `refreshToken`. A `refreshToken` lets us get a new `id_token` (`JWT`) anytime we want.
 
