diff --git a/storybook/src/PluginDocs/PostgresPlugin/CLI Reference/index.stories.mdx b/storybook/src/PluginDocs/PostgresPlugin/CLI Reference/index.stories.mdx index 73cff51..74ce88a 100644 --- a/storybook/src/PluginDocs/PostgresPlugin/CLI Reference/index.stories.mdx +++ b/storybook/src/PluginDocs/PostgresPlugin/CLI Reference/index.stories.mdx @@ -9,46 +9,30 @@ import { Canvas, Meta, Story } from "@storybook/addon-docs"; # CLI Reference -## - - - - postgres - +## Postgres
- * This command will show the list of available commands with postgres instance. - - In order to run this command with your **Gluestack App**, you need to run the below - command: - -
- - ```bash - $ node glue postgres - ``` + * This command will display a list of available commands for the **postgres instance**. To execute this command using your **Gluestack App**, please run the following command:
- * In order show the list of installed **postgres instance** you need to run the following - command: + * To display the list of **postgres instances** that have been installed, please use the following command:
```bash - $ node glue postgres list + $ node glue postgres:list ```
- * Inorder to change **configuration** of your **postgres instance** you need to run the - following command: + * To modify the **configuration** of your **postgres instance**, please use the following command:
```bash - $ node glue postgres config + $ node glue postgres:config ```
diff --git a/storybook/src/PluginDocs/PostgresPlugin/Getting Started/index.stories.mdx b/storybook/src/PluginDocs/PostgresPlugin/Getting Started/index.stories.mdx index 2475d50..0cde205 100644 --- a/storybook/src/PluginDocs/PostgresPlugin/Getting Started/index.stories.mdx +++ b/storybook/src/PluginDocs/PostgresPlugin/Getting Started/index.stories.mdx @@ -13,4 +13,4 @@ import { Canvas, Meta, Story } from '@storybook/addon-docs';
-This plugin adds **Postgres** as a service into your gluestack project. +With this plugin, **Postgres** is added to your gluestack project as an instance. diff --git a/storybook/src/PluginDocs/PostgresPlugin/Goals/index.stories.mdx b/storybook/src/PluginDocs/PostgresPlugin/Goals/index.stories.mdx deleted file mode 100644 index 18abfb3..0000000 --- a/storybook/src/PluginDocs/PostgresPlugin/Goals/index.stories.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Goals | Postgres -description: Goals | Postgres ---- - -import { Canvas, Meta, Story } from "@storybook/addon-docs"; - - - -# Goals - -## - -
- -- Install **postgres instance** into your **Gluestack Application**. - -
- -- Run **postgres instance** through **Backend-Engine Plugin Instance**. - -
- -- **Postgres instance** will act as your database for the application. - We can interact with it by installing other plugins like **Glue Plugin - Graphql** which depends upon this plugin in order to interact with - data. - -
diff --git a/storybook/src/PluginDocs/PostgresPlugin/How to Install/index.stories.mdx b/storybook/src/PluginDocs/PostgresPlugin/How to Install/index.stories.mdx index 764b828..a40f523 100644 --- a/storybook/src/PluginDocs/PostgresPlugin/How to Install/index.stories.mdx +++ b/storybook/src/PluginDocs/PostgresPlugin/How to Install/index.stories.mdx @@ -1,6 +1,6 @@ --- -title: How to install | Postgres -description: How to install | Postgres +title: How to Install | Postgres +description: How to Install | Postgres --- import { Canvas, Meta, Story } from '@storybook/addon-docs'; @@ -8,7 +8,7 @@ import { Canvas, Meta, Story } from '@storybook/addon-docs'; -# How to install +# How to Install To add postgres into your gluestack project, you can run the following command in project's root directory: ```sh diff --git a/storybook/src/PluginDocs/PostgresPlugin/HowItWorks/index.stories.mdx b/storybook/src/PluginDocs/PostgresPlugin/HowItWorks/index.stories.mdx deleted file mode 100644 index 7ed48c9..0000000 --- a/storybook/src/PluginDocs/PostgresPlugin/HowItWorks/index.stories.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: How it works| Postgres -description: How it works| Postgres ---- - -import { Canvas, Meta, Story } from "@storybook/addon-docs"; - - - - -# How it works - -## - -
- -* ## Working - -
- - * **Postgres Plugin Instance** image will be running inside a docker container which - is managed by your **Backend-Engine** plugin. - - -
- - - * Behind the scene what is happening is, when you have installed the postgres plugin and - configured it, your **Glue Backend-Engine Plugin** adds **postgres** image inside its docker file - and from there it runs the postgres image. - - -
- - - * Your directory stucture for the **postgres plugin instance** will be something - like this: -
- - ```jsx - 📦databases - ┗ 📂postgres - ┗ 📜README.md - ``` -
-
- - - * In order to start running this plugin you need to run the following command: - -
- - ```bash - $ node glue develop:up - ``` - -
- - This command will start running the docker container of all the instances - and plugin you have created. Here, in this case it will start running - your **postgres plugin instance** container, with the help of your **Backend-Engine - plugin instance**. - -
-
- -* ## Instructions to start development with this plugin - -
- - * In order to interact with **postgres plugin database**, you can install another - plugin named **Glue Plugin Graphql** which injects **Hasura Engine** which is - connected with your postgres database. - - - - - - - - - - - - - - diff --git a/storybook/src/PluginDocs/PostgresPlugin/Requirements/index.stories.mdx b/storybook/src/PluginDocs/PostgresPlugin/Requirements/index.stories.mdx index de2cc4f..3924026 100644 --- a/storybook/src/PluginDocs/PostgresPlugin/Requirements/index.stories.mdx +++ b/storybook/src/PluginDocs/PostgresPlugin/Requirements/index.stories.mdx @@ -14,7 +14,7 @@ import { Canvas, Meta, Story } from '@storybook/addon-docs';
Postgres requires Backend-Engine plugin's instance to be installed.
-You can add one if it does not already exist using the following command: +You can add one if it does not exist already using the following command: ```sh $ node glue add backend-engine engine ```