move url reader docs to plugins -> backend apis

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>

docs/plugins/url-reader.md

@@ -24,8 +24,8 @@ package provides a dedicated API for reading from such URL based remote
 locations like GitHub, GitLab, Bitbucket, Google Cloud Storage, etc. This is
 commonly referred to as "URL Reader". It takes care of making authenticated
 requests to the remote host so that private files can be read securely. If users
-have [GitHub App based authentication](../plugins/github-apps.md) set up, URL
-Reader even refreshes the token, to avoid reaching the GitHub API rate limit.
+have [GitHub App based authentication](github-apps.md) set up, URL Reader even
+refreshes the token, to avoid reaching the GitHub API rate limit.
 
 As a result, plugin authors do not have to worry about any of these problems
 when trying to read files.
@@ -61,6 +61,14 @@ The generic interface of a URL Reader instance looks like this.
 export type UrlReader = {
   /* Used to read a single file and return its content. */
   read(url: string): Promise<Buffer>;
+  /**
+   * A replacement for the read method that supports options and complex responses.
+   *
+   * Use this whenever it is available, as the read method will be deprecated and
+   * eventually removed in the future.
+   */
+  readUrl?(url: string, options?: ReadUrlOptions): Promise<ReadUrlResponse>;
+
   /* Used to read a file tree and download as a directory. */
   readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
   /* Used to search a file in a tree. */

microsite/sidebars.json

@@ -149,8 +149,7 @@
         "type": "subcategory",
         "label": "LDAP",
         "ids": ["integrations/ldap/org"]
-      },
-      "integrations/url-reader"
+      }
     ],
     "Plugins": [
       "plugins/index",
@@ -167,7 +166,8 @@
           "plugins/proxying",
           "plugins/backend-plugin",
           "plugins/call-existing-api",
-          "plugins/github-apps"
+          "plugins/github-apps",
+          "plugins/url-reader"
         ]
       },
       {

mkdocs.yml

@@ -98,7 +98,6 @@ nav:
           - Locations: 'integrations/google-cloud-storage/locations.md'
       - LDAP:
           - Org Data: 'integrations/ldap/org.md'
-      - URL Reader: 'integrations/url-reader.md'
   - Plugins:
       - Intro to plugins: 'plugins/index.md'
       - Existing plugins: 'plugins/existing-plugins.md'
@@ -113,6 +112,7 @@ nav:
           - Backend plugin: 'plugins/backend-plugin.md'
           - Call existing API: 'plugins/call-existing-api.md'
           - GitHub Apps for Backend Authentication: 'plugins/github-apps.md'
+          - URL Reader: 'plugins/url-reader.md'
       - Testing:
           - Testing with Jest: 'plugins/testing.md'
       - Publishing: