updated all doc links

2021-02-03 20:45:16 +05:30 · 2021-02-03 20:45:16 +05:30 · 486a9da8dd
commit 486a9da8dd
parent db9c2d6c27
13 changed files with 67 additions and 61 deletions
--- a/.env.example
+++ b/.env.example
@ -50,7 +50,7 @@ APPSMITH_MAIL_SMTP_TLS_ENABLED=

 # Disable all telemetry
 # Note: This only takes effect in self-hosted scenarios. 
-# Please visit: https://docs.appsmith.com/telemetry/telemetry to read more about anonymized data collected by Appsmith
+# Please visit: https://docs.appsmith.com/v/v1.2.1/setup/telemetry to read more about anonymized data collected by Appsmith
 # APPSMITH_DISABLE_TELEMETRY=false

 #APPSMITH_SENTRY_DSN=
--- a/app.json
+++ b/app.json
@ -94,12 +94,12 @@
        "required": false
      },
      "APPSMITH_GOOGLE_MAPS_API_KEY": {
-        "description" : "Google Maps API key which is required if you wish to leverage Google Maps widget. Read more at: https://docs.appsmith.com/third-party-services/google-maps",
+        "description" : "Google Maps API key which is required if you wish to leverage Google Maps widget. Read more at: https://docs.appsmith.com/v/v1.2.1/setup/docker/google-maps",
        "value": "",
        "required": false
      },
      "APPSMITH_DISABLE_TELEMETRY": {
-        "description" : "We want to be transparent and request that you share anonymous usage data with us. This data is purely statistical in nature and helps us understand your needs & provide better support to your self-hosted instance. You can read more about what information is collected in our documentation https://docs.appsmith.com/telemetry/telemetry",
+        "description" : "We want to be transparent and request that you share anonymous usage data with us. This data is purely statistical in nature and helps us understand your needs & provide better support to your self-hosted instance. You can read more about what information is collected in our documentation https://docs.appsmith.com/v/v1.2.1/setup/telemetry",
        "value": "false"
      }
   }
--- a/app/client/src/pages/Editor/Explorer/JSDependencies.tsx
+++ b/app/client/src/pages/Editor/Explorer/JSDependencies.tsx
@ -63,7 +63,7 @@ export const JSDependencies = () => {
  const toggleDependencies = () => setIsOpen(!isOpen);
  const showDocs = (e: any) => {
    window.open(
-      "https://docs.appsmith.com/core-concepts/connecting-ui-and-logic/working-with-js-libraries",
+      "https://docs.appsmith.com/v/v1.2.1/core-concepts/writing-code/ext-libraries",
      "appsmith-docs:working-with-js-libraries",
    );
    e.stopPropagation();
--- a/app/client/src/pages/UserAuth/ForgotPassword.tsx
+++ b/app/client/src/pages/UserAuth/ForgotPassword.tsx
@ -92,7 +92,7 @@ export const ForgotPassword = withTheme(
              }
              actions={[
                {
-                  url: "https://docs.appsmith.com/third-party-services/email",
+                  url: "https://docs.appsmith.com/v/v1.2.1/setup/docker/email",
                  text: "Configure Email service",
                  intent: "primary",
                },
--- a/app/client/src/pages/organization/OrgInviteUsersForm.tsx
+++ b/app/client/src/pages/organization/OrgInviteUsersForm.tsx
@ -348,7 +348,7 @@ const OrgInviteUsersForm = (props: any) => {
                {allUsers.length === 0 && <NoEmailConfigImage />}
                <span>You haven’t setup any email service yet</span>
                <a
-                  href="https://docs.appsmith.com/third-party-services/email"
+                  href="https://docs.appsmith.com/v/v1.2.1/setup/docker/email"
                  target="_blank"
                  rel="noopener noreferrer"
                >
--- a/app/client/src/utils/autocomplete/EntityDefinitions.ts
+++ b/app/client/src/utils/autocomplete/EntityDefinitions.ts
@ -25,7 +25,7 @@ export const entityDefinitions = {
    return {
      "!doc":
        "Actions allow you to connect your widgets to your backend data in a secure manner.",
-      "!url": "https://docs.appsmith.com/quick-start#connect-your-apis",
+      "!url": "https://docs.appsmith.com/v/v1.2.1/framework-reference/run",
      isLoading: "bool",
      data,
      run: "fn(onSuccess: fn() -> void, onError: fn() -> void) -> void",
@ -34,10 +34,10 @@ export const entityDefinitions = {
  CONTAINER_WIDGET: {
    "!doc":
      "Containers are used to group widgets together to form logical higher order widgets. Containers let you organize your page better and move all the widgets inside them together.",
-    "!url": "https://docs.appsmith.com/widget-reference/how-to-use-widgets",
+    "!url": "https://docs.appsmith.com/widget-reference/container",
    backgroundColor: {
      "!type": "string",
-      "!url": "https://docs.appsmith.com/widget-reference/how-to-use-widgets",
+      "!url": "https://docs.appsmith.com/widget-reference/container",
    },
    isVisible: isVisible,
  },
--- a/app/client/src/widgets/MapWidget.tsx
+++ b/app/client/src/widgets/MapWidget.tsx
@ -154,7 +154,7 @@ class MapWidget extends BaseWidget<MapWidgetProps, WidgetState> {
              <a
                target="_blank"
                rel="noopener noreferrer"
-                href="https://docs.appsmith.com/third-party-services/google-maps"
+                href="https://docs.appsmith.com/v/v1.2.1/setup/docker/google-maps"
              >
                {" documentation "}
              </a>
--- a/app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/DatabaseChangelog.java
+++ b/app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/DatabaseChangelog.java
@ -585,11 +585,11 @@ public class DatabaseChangelog {
        for (Plugin plugin : mongoTemplate.findAll(Plugin.class)) {
            if ("postgres-plugin".equals(plugin.getPackageName())) {
                plugin.setDocumentationLink(
-                        "https://docs.appsmith.com/core-concepts/connecting-to-databases/querying-postgres");
+                        "");

            } else if ("mongo-plugin".equals(plugin.getPackageName())) {
                plugin.setDocumentationLink(
-                        "https://docs.appsmith.com/core-concepts/connecting-to-databases/querying-mongodb");
+                        "https://docs.appsmith.com/v/v1.2.1/datasource-reference/querying-mongodb");

            } else {
                continue;
@ -978,7 +978,7 @@ public class DatabaseChangelog {
        plugin1.setUiComponent("DbEditorForm");
        plugin1.setResponseType(Plugin.ResponseType.JSON);
        plugin1.setIconLocation("https://s3.us-east-2.amazonaws.com/assets.appsmith.com/ElasticSearch.jpg");
-        plugin1.setDocumentationLink("https://docs.appsmith.com/core-concepts/connecting-to-databases/querying-elasticsearch");
+        plugin1.setDocumentationLink("https://docs.appsmith.com/v/v1.2.1/datasource-reference/querying-elasticsearch");
        plugin1.setDefaultInstall(true);
        try {
            mongoTemplate.insert(plugin1);
@ -998,7 +998,7 @@ public class DatabaseChangelog {
        plugin1.setUiComponent("DbEditorForm");
        plugin1.setResponseType(Plugin.ResponseType.JSON);
        plugin1.setIconLocation("https://s3.us-east-2.amazonaws.com/assets.appsmith.com/DynamoDB.png");
-        plugin1.setDocumentationLink("https://docs.appsmith.com/core-concepts/connecting-to-databases/querying-dynamodb");
+        plugin1.setDocumentationLink("https://docs.appsmith.com/v/v1.2.1/datasource-reference/querying-dynamodb");
        plugin1.setDefaultInstall(true);
        try {
            mongoTemplate.insert(plugin1);
@ -1028,7 +1028,7 @@ public class DatabaseChangelog {
        plugin1.setUiComponent("DbEditorForm");
        plugin1.setResponseType(Plugin.ResponseType.TABLE);
        plugin1.setIconLocation("https://s3.us-east-2.amazonaws.com/assets.appsmith.com/redis.jpg");
-        plugin1.setDocumentationLink("https://docs.appsmith.com/core-concepts/connecting-to-databases/querying-redis");
+        plugin1.setDocumentationLink("https://docs.appsmith.com/v/v1.2.1/datasource-reference/querying-redis");
        plugin1.setDefaultInstall(true);
        try {
            mongoTemplate.insert(plugin1);
@ -1048,7 +1048,7 @@ public class DatabaseChangelog {
        plugin1.setUiComponent("DbEditorForm");
        plugin1.setResponseType(Plugin.ResponseType.TABLE);
        plugin1.setIconLocation("https://s3.us-east-2.amazonaws.com/assets.appsmith.com/MsSQL.jpg");
-        plugin1.setDocumentationLink("https://docs.appsmith.com/core-concepts/connecting-to-databases/querying-mssql");
+        plugin1.setDocumentationLink("https://docs.appsmith.com/v/v1.2.1/datasource-reference/querying-mssql");
        plugin1.setDefaultInstall(true);
        try {
            mongoTemplate.insert(plugin1);
@ -1256,7 +1256,7 @@ public class DatabaseChangelog {
        plugin.setUiComponent("DbEditorForm");
        plugin.setResponseType(Plugin.ResponseType.JSON);
        plugin.setIconLocation("https://s3.us-east-2.amazonaws.com/assets.appsmith.com/Firestore.png");
-        plugin.setDocumentationLink("https://docs.appsmith.com/core-concepts/connecting-to-databases/querying-firestore");
+        plugin.setDocumentationLink("https://docs.appsmith.com/v/v1.2.1/datasource-reference/querying-firestore");
        plugin.setDefaultInstall(true);
        try {
            mongoTemplate.insert(plugin);
@ -1563,7 +1563,7 @@ public class DatabaseChangelog {
        plugin.setUiComponent("DbEditorForm");
        plugin.setResponseType(Plugin.ResponseType.TABLE);
        plugin.setIconLocation("https://s3.us-east-2.amazonaws.com/assets.appsmith.com/Redshift.png");
-        plugin.setDocumentationLink("https://docs.appsmith.com/core-concepts/connecting-to-databases/querying-redshift");
+        plugin.setDocumentationLink("https://docs.appsmith.com/v/v1.2.1/datasource-reference/querying-redshift");
        plugin.setDefaultInstall(true);
        try {
            mongoTemplate.insert(plugin);
--- a/deploy/ansible/appsmith_playbook/roles/generate_template/templates/docker.env.j2
+++ b/deploy/ansible/appsmith_playbook/roles/generate_template/templates/docker.env.j2
@ -1,5 +1,5 @@
 # Read our documentation on how to configure these features
-# https://docs.appsmith.com/v/v1.1/enabling-3p-services
+# https://docs.appsmith.com/v/v1.2.1/setup/docker#enabling-services-for-self-hosting

 # ***** Email **********
 APPSMITH_MAIL_ENABLED={{ mail_enabled }}
--- a/deploy/heroku/README.MD
+++ b/deploy/heroku/README.MD
@ -1,17 +1,21 @@
 ## Deploy Appsmith using Heroku
+
 Quickly set up Appsmith to explore product functionality using Heroku.

 ## Heroku Installation
+
 - Sign up for a free account on Heroku
 - Click the [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/appsmithorg/appsmith/tree/master) button
- Fill in the required `Config Variables`  including:
+- Fill in the required `Config Variables` including:
  - `APPSMITH_ENCRYPTION_PASSWORD`: Encryption password to encrypt all credentials in the database
  - `APPSMITH_ENCRYPTION_SALT`: Encryption salt used to encrypt all credentials in the database
  - `APPSMITH_MONGODB_URI`: Your Mongo Database URI
 - (Optional) Customize the default settings in Heroku
+
  - `App Name`: Optionally select a name for your application (this will be used in the app URL)
  - `Runtime Selection`: Select which region your app should run in (United States or Europe)
  - `Config Variables`:
+
    - Email Configuration:
      - `APPSMITH_MAIL_ENABLED`: Set this value to true to enable email sending (value should be `true/false` only)
      - `APPSMITH_MAIL_FROM`: Email ID using which emails will be sent from your installation
@ -27,64 +31,66 @@ Quickly set up Appsmith to explore product functionality using Heroku.
      - Github Oauth:
        - `APPSMITH_OAUTH2_GITHUB_CLIENT_ID`: Client ID provided by Github for OAuth2 login
        - `APPSMITH_OAUTH2_GITHUB_CLIENT_SECRET`: Client secret provided by Github for OAuth2 login
-    - `APPSMITH_GOOGLE_MAPS_API_KEY`: Google Maps API key which is required if you wish to leverage Google Maps widget. Read more at: https://docs.appsmith.com/third-party-services/google-maps
-    - `APPSMITH_DISABLE_TELEMETRY`: We want to be transparent and request that you share anonymous usage data with us. This data is purely statistical in nature and helps us understand your needs & provide better support to your self-hosted instance. You can read more about what information is collected in our documentation https://docs.appsmith.com/telemetry/telemetry
+    - `APPSMITH_GOOGLE_MAPS_API_KEY`: Google Maps API key which is required if you wish to leverage Google Maps widget. Read more at: https://docs.appsmith.com/v/v1.2.1/setup/docker/google-maps
+    - `APPSMITH_DISABLE_TELEMETRY`: We want to be transparent and request that you share anonymous usage data with us. This data is purely statistical in nature and helps us understand your needs & provide better support to your self-hosted instance. You can read more about what information is collected in our documentation https://docs.appsmith.com/v/v1.2.1/setup/telemetry

    After Heroku finishes setting up the app, click “View” and your Appsmith should be up and running. You will be taken to the account creation page, where you can enter credentials to create an account and get started.

-
 {% hint style="warning" %}
+
 - We use Heroku Redis addon for caching which required your account to have billing information, but we use the free plan of this addon so it will charge you nothing. Please make sure your account already finish providing billing information.
 - You may need to wait 2 - 3 minutes before accessing the application.
-{% endhint %}
-
+  {% endhint %}

 ## Custom domain
+
 To create your custom domain with your app, please follow these steps below:
+
 - Go to your app's settings tab
-![App setting](./images/app-settings.png)
+  ![App setting](./images/app-settings.png)
 - Click `Add domain` button in Domains section
-![Add domain button](./images/add-domain-button.png)
+  ![Add domain button](./images/add-domain-button.png)
 - Input your domain name & click `Next`. Heroku will provide you a DNS Target that you can map your domain with  
-![Add domain form](./images/add-domain-form.png)  
-![Finish](./images/finish.png)
+  ![Add domain form](./images/add-domain-form.png)  
+  ![Finish](./images/finish.png)

 - Make sure that your DNS Record is update so that your custom domain will map to `DNS Target`

 - Once you finish, now you can access Appsmith from your custom domain

 {% hint style="warning" %}
+
 - Once you use a custom domain, You might want to setup SSL for your dyno. Please check the official document of Heroku [how to configure SSL](https://devcenter.heroku.com/articles/ssl)
 - Your dyno will need to be upgrade to at least `hobby` type to use this feature of heroku

 {% endhint %}

-
 ## Re-Deploy your App using Heroku CLI
-To re-deploy your app (re-build & re-run), make sure you have Docker & Heroku CLI setup locally then follow steps below:
- Pull the appsmith repository & move to `heroku` folder:
-    ```
-    git clone --branch master https://github.com/appsmithorg/appsmith
-    cd ./appsmith/deploy/heroku
-    ```
- Login to Heroku CLI
-    ```
-    heroku login
-    ```
- Login to Container Registry
-    ```
-    heroku container:login
-    ```
- Get your application name
-    ```
-    heroku apps
-    ```
- Push your Docker-based app
-    ```
-    heroku container:push web -a <Your App Name>
-    ```
- Deploy the changes
-    ```
-    heroku container:release web -a <Your App Name>
-    ```

+To re-deploy your app (re-build & re-run), make sure you have Docker & Heroku CLI setup locally then follow steps below:
+
+- Pull the appsmith repository & move to `heroku` folder:
+  ```
+  git clone --branch master https://github.com/appsmithorg/appsmith
+  cd ./appsmith/deploy/heroku
+  ```
+- Login to Heroku CLI
+  ```
+  heroku login
+  ```
+- Login to Container Registry
+  ```
+  heroku container:login
+  ```
+- Get your application name
+  ```
+  heroku apps
+  ```
+- Push your Docker-based app
+  ```
+  heroku container:push web -a <Your App Name>
+  ```
+- Deploy the changes
+  ```
+  heroku container:release web -a <Your App Name>
+  ```
--- a/deploy/install.sh
+++ b/deploy/install.sh
@ -383,7 +383,7 @@ ask_telemetry() {
    echo "+++++++++++ IMPORTANT ++++++++++++++++++++++"
    echo -e "Thank you for installing appsmith! We want to be transparent and request that you share anonymous usage data with us."
    echo -e "This data is purely statistical in nature and helps us understand your needs & provide better support to your self-hosted instance."
-    echo -e "You can read more about what information is collected in our documentation https://docs.appsmith.com/telemetry/telemetry"
+    echo -e "You can read more about what information is collected in our documentation https://docs.appsmith.com/v/v1.2.1/setup/telemetry"
    echo -e ""
    if confirm y 'Would you like to share anonymous usage data and receive better support?'; then
        disable_telemetry="false"
@ -611,7 +611,7 @@ if confirm n "Do you have a custom domain that you would like to link? (Only for
    echo "+++++++++++ IMPORTANT PLEASE READ ++++++++++++++++++++++"
    echo "Please update your DNS records with your domain registrar"
    echo "You can read more about this in our Documentation"
-    echo "https://docs.appsmith.com/v/v1.1/quick-start#custom-domains"
+    echo "https://docs.appsmith.com/v/v1.2.1/setup#custom-domains"
    echo "+++++++++++++++++++++++++++++++++++++++++++++++"
    echo ""
    echo "Would you like to provision an SSL certificate for your custom domain / subdomain?"
--- a/deploy/k8s/install.k8s.sh
+++ b/deploy/k8s/install.k8s.sh
@ -286,7 +286,7 @@ ask_telemetry() {
    echo "+++++++++++ IMPORTANT ++++++++++++++++++++++"
    echo -e "Thank you for installing appsmith! We want to be transparent and request that you share anonymous usage data with us."
    echo -e "This data is purely statistical in nature and helps us understand your needs & provide better support to your self-hosted instance."
-    echo -e "You can read more about what information is collected in our documentation https://docs.appsmith.com/telemetry/telemetry"
+    echo -e "You can read more about what information is collected in our documentation https://docs.appsmith.com/v/v1.2.1/setup/telemetry"
    echo -e ""
    if confirm y 'Would you like to share anonymous usage data and receive better support?'; then
        disable_telemetry="false"
@ -450,7 +450,7 @@ if confirm n "Do you have a custom domain that you would like to link? (Only for
    echo "+++++++++++ IMPORTANT PLEASE READ ++++++++++++++++++++++"
    echo "Please update your DNS records with your domain registrar"
    echo "You can read more about this in our Documentation"
-    echo "https://docs.appsmith.com/v/v1.1/quick-start#custom-domains"
+    echo "https://docs.appsmith.com/v/v1.2.1/setup#custom-domains"
    echo "+++++++++++++++++++++++++++++++++++++++++++++++"
    echo ""
    echo "Would you like to provision an SSL certificate for your custom domain / subdomain?"
--- a/deploy/template/docker.env.sh
+++ b/deploy/template/docker.env.sh
@ -9,7 +9,7 @@ disable_telemetry="$4"

 cat << EOF
 # Read our documentation on how to configure these features
-# https://docs.appsmith.com/v/v1.1/enabling-3p-services
+# https://docs.appsmith.com/v/v1.2.1/setup/docker#enabling-services-for-self-hosting

 # ***** Email **********
 APPSMITH_MAIL_ENABLED=false