move deprecated content to deprecated section (#1684)

Platform-OS · Dec 28, 2023 · f694aba · f694aba
1 parent 898e73a
commit f694aba
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 27 deletions.
diff --git a/app/views/pages/developer-guide/apis/creating-items-from-external-api-call.liquid b/app/views/pages/developer-guide/apis/creating-items-from-external-api-call.liquid
@@ -7,6 +7,8 @@ metadata:
 
 This guide will help you create items from an external API call. The example shows the steps of creating a Record from existing data through an API call to our service.
 
+{% include 'alert/deprecated', content: 'This article is **deprecated**. The easiest way to build your API to be consumed by third party systems is by creating Pages with manually implemented business logic' %}
+
 ## Requirements
 This is an advanced tutorial. To follow it, you should be familiar with basic platformOS concepts, HTML, Liquid, APIs and Forms, and the topics in the Get Started section.
 

diff --git a/app/views/pages/developer-guide/apis/persisting-part-of-third-party-api-response.liquid b/app/views/pages/developer-guide/apis/persisting-part-of-third-party-api-response.liquid
@@ -7,6 +7,8 @@ metadata:
 
 This guide will help you persist part of a third-party API response by walking you through an example.
 
+{% include 'alert/deprecated', content: 'This article is **deprecated**. The easiest way to work with third party api is to invoke api calls via mutation, which would return a response, and then use liquid to implement business rules based on the response' %}
+
 ## Requirements
 This is an advanced tutorial. To follow it, you should be familiar with basic platformOS concepts, HTML, GraphQL queries, Liquid, YAML, and the topics in the Get Started section, especially topics related to pages, users, and notifications.
 

diff --git a/app/views/pages/developer-guide/identity-providers/auth0.liquid b/app/views/pages/developer-guide/identity-providers/auth0.liquid
@@ -4,8 +4,11 @@ metadata:
   title: Identity provider - Auth0
   description: This guide will help you configure and integrate with Auth0.
 ---
+
 This guide will help you configure and integrate with Auth0.
 
+{% include 'alert/deprecated', content: 'Using hardcoded OAuth integrations is deprecated, as it does limit your flexibilty to implement business rules. Our recommendation is to use Liquid and GraphQL implement the OAuth per your the requirements. To expedite and unify the process, OAuth module will be available soon.' %}
+
 ## Requirements
 
 To follow the steps in this tutorial, you should be familiar with Users and Identity Providers. This guide builds on previous tutorials in the **Developer Guide: Identity Providers** section.

diff --git a/app/views/pages/developer-guide/identity-providers/facebook.liquid b/app/views/pages/developer-guide/identity-providers/facebook.liquid
@@ -6,6 +6,8 @@ metadata:
 ---
 This guide will help you configure and integrate with Facebook.
 
+{% include 'alert/deprecated', content: 'Using hardcoded OAuth integrations is deprecated, as it does limit your flexibilty to implement business rules. Our recommendation is to use Liquid and GraphQL implement the OAuth per your the requirements. To expedite and unify the process, OAuth module will be available soon.' %}
+
 ## Requirements
 To follow the steps in this tutorial, you should be familiar with Users and Identity Providers. This guide builds on previous tutorials in the **Developer Guide: Identity Providers** section.
 

diff --git a/app/views/pages/developer-guide/identity-providers/google-oauth.liquid b/app/views/pages/developer-guide/identity-providers/google-oauth.liquid
@@ -6,6 +6,8 @@ metadata:
 ---
 This guide will help you configure and integrate with Google OAuth.
 
+{% include 'alert/deprecated', content: 'Using hardcoded OAuth integrations is deprecated, as it does limit your flexibilty to implement business rules. Our recommendation is to use Liquid and GraphQL implement the OAuth per your the requirements. To expedite and unify the process, OAuth module will be available soon.' %}
+
 ## Requirements
 To follow the steps in this tutorial, you should be familiar with Users and Identity Providers. This guide builds on previous tutorials in the **Developer Guide: Identity Providers** section.
 

diff --git a/app/views/pages/developer-guide/identity-providers/identity-providers.liquid b/app/views/pages/developer-guide/identity-providers/identity-providers.liquid
@@ -6,6 +6,9 @@ metadata:
 ---
 
 This guide will help you understand generic steps of configuring third party identity providers like Facebook login, Auth0 etc.
+
+{% include 'alert/deprecated', content: 'Using hardcoded OAuth integrations is deprecated, as it does limit your flexibilty to implement business rules. Our recommendation is to use Liquid and GraphQL implement the OAuth per your the requirements. To expedite and unify the process, OAuth module will be available soon.' %}
+
 The integration allows you to:
 
 * Connect a User from an external service with a User in your Instance via email
@@ -14,13 +17,13 @@ The integration allows you to:
 
 This is **how identity providers work**:
 
-1. If the user tries to use an identity provider with abc@example.com and such a user does not exist an account is created. 
-2. If the user tries to use an identity provider with abc@example.com and such a user exists but is not connected to the identity provider this is what happens: 
-   * If the user is logged in as abc@example.com, connecting the accounts is allowed, next time the user will be able to log in using the identity provider. 
-   * If the user is not logged in, an error message is displayed saying such an account exists and is not connected to the identity provider. 
-   * If the user is logged in to a different account, they are notified that they are logged in to a different account and need to log out. 
-3. If the user tries to use the identity provider with abc@example.com and such a user is connected to the identity provider then they are allowed to log in. 
-   * If the user is not logged in, they are allowed to log in. 
+1. If the user tries to use an identity provider with abc@example.com and such a user does not exist an account is created.
+2. If the user tries to use an identity provider with abc@example.com and such a user exists but is not connected to the identity provider this is what happens:
+   * If the user is logged in as abc@example.com, connecting the accounts is allowed, next time the user will be able to log in using the identity provider.
+   * If the user is not logged in, an error message is displayed saying such an account exists and is not connected to the identity provider.
+   * If the user is logged in to a different account, they are notified that they are logged in to a different account and need to log out.
+3. If the user tries to use the identity provider with abc@example.com and such a user is connected to the identity provider then they are allowed to log in.
+   * If the user is not logged in, they are allowed to log in.
    * If the user is logged in with a different email, an error message is displayed saying they need to log out.
 
 ## Requirements

diff --git a/...y-file-using-api-call-notification.liquid → ...y-file-using-api-call-notification.liquid b/...y-file-using-api-call-notification.liquid → ...y-file-using-api-call-notification.liquid
diff --git a/app/views/partials/shared/nav/developer-guide.liquid b/app/views/partials/shared/nav/developer-guide.liquid
@@ -229,6 +229,7 @@
       {% include "shared/nav/link", href: "/developer-guide/notifications/adding-attachments-email-notification", text: "Adding Attachments to an Email Notification" %}
       {% include "shared/nav/link", href: "/developer-guide/notifications/creating-sms-notification", text: "Creating an SMS Notification" %}
       {% include "shared/nav/link", href: "/developer-guide/notifications/creating-api-call-notification", text: "Creating an API Call Notification" %}
+      {% include "shared/nav/link", href: "/developer-guide/notifications/sending-binary-file-using-api-call-notification", text: "Sending a Binary File Using an API Call Notification" %}
       {% include "shared/nav/link", href: "/developer-guide/notifications/parsing-api-response", text: "Parsing an API Response" %}
     </ul>
   {% endif %}
@@ -313,14 +314,6 @@
 <li class="pt-6 mt-6 mb-2 text-base border-t topic-group border-pos-divider">
   <h3 class="text-base uppercase">Third-party systems</h3>
 </li>
-<li class="{% if cp contains 'apis' %}active{% endif %}">
-  <a href="/developer-guide/apis/creating-items-from-external-api-call">APIs</a>
-  <ul class="submenu">
-    {% include "shared/nav/link", href: "/developer-guide/apis/creating-items-from-external-api-call", text: "Creating Items from an External API Call" %}
-    {% include "shared/nav/link", href: "/developer-guide/apis/persisting-part-of-third-party-api-response", text: "Persisting Part of a Third-Party API Response" %}
-    {% include "shared/nav/link", href: "/developer-guide/apis/sending-binary-file-using-api-call-notification", text: "Sending a Binary File Using an API Call Notification" %}
-  </ul>
-</li>
 
 <li class="{% if cp contains 'integrations' %}active{% endif %}">
   <a href="/developer-guide/integrations/integrations">Integrations</a>
@@ -343,18 +336,6 @@
   {% endif %}
 </li>
 
-<li class="{% if cp contains 'identity-providers' %}active{% endif %}">
-  <a href="/developer-guide/identity-providers/identity-providers">Identity Providers (OAuth)</a>
-  {% if cp contains 'identity-providers' %}
-    <ul class="submenu">
-      {% include "shared/nav/link", href: "/developer-guide/identity-providers/identity-providers", text: "Identity Providers" %}
-      {% include "shared/nav/link", href: "/developer-guide/identity-providers/auth0", text: "Auth0 Integration" %}
-      {% include "shared/nav/link", href: "/developer-guide/identity-providers/google-oauth", text: "Google OAuth Integration" %}
-      {% include "shared/nav/link", href: "/developer-guide/identity-providers/facebook", text: "Facebook Integration" %}
-    </ul>
-  {% endif %}
-</li>
-
 <li class="pt-6 mt-6 mb-2 text-base border-t topic-group border-pos-divider">
   <h3 class="text-base uppercase">Partner Portal</h3>
 </li>
@@ -478,3 +459,21 @@
     </ul>
   {% endif %}
 </li>
+<li class="{% if cp contains 'apis' %}active{% endif %}">
+  <a href="/developer-guide/apis/creating-items-from-external-api-call">Accessing Forms via API</a>
+  <ul class="submenu">
+    {% include "shared/nav/link", href: "/developer-guide/apis/creating-items-from-external-api-call", text: "Creating Items from an External API Call" %}
+    {% include "shared/nav/link", href: "/developer-guide/apis/persisting-part-of-third-party-api-response", text: "Persisting Part of a Third-Party API Response" %}
+  </ul>
+</li>
+<li class="{% if cp contains 'identity-providers' %}active{% endif %}">
+  <a href="/developer-guide/identity-providers/identity-providers">Identity Providers (OAuth)</a>
+  {% if cp contains 'identity-providers' %}
+    <ul class="submenu">
+      {% include "shared/nav/link", href: "/developer-guide/identity-providers/identity-providers", text: "Identity Providers" %}
+      {% include "shared/nav/link", href: "/developer-guide/identity-providers/auth0", text: "Auth0 Integration" %}
+      {% include "shared/nav/link", href: "/developer-guide/identity-providers/google-oauth", text: "Google OAuth Integration" %}
+      {% include "shared/nav/link", href: "/developer-guide/identity-providers/facebook", text: "Facebook Integration" %}
+    </ul>
+  {% endif %}
+</li>