Skip to content

chore: update storybook docs #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 3, 2023
Merged

chore: update storybook docs #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 6 additions & 22 deletions storybook/src/PluginDocs/PostgresPlugin/CLI Reference/index.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,46 +9,30 @@ import { Canvas, Meta, Story } from "@storybook/addon-docs";

# CLI Reference

##


<summary>
<strong> postgres</strong>
</summary>
## Postgres

<br/>

* 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:

<br/>

```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:

<br/>

* 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:

<br/>

```bash
$ node glue postgres list
$ node glue postgres:list
```

<br/>

* 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:

<br/>

```bash
$ node glue postgres config
$ node glue postgres:config
```

<br/>
Expand Down
2 changes: 1 addition & 1 deletion storybook/src/PluginDocs/PostgresPlugin/Getting Started/index.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ import { Canvas, Meta, Story } from '@storybook/addon-docs';

<br/>

This plugin adds **Postgres** as a service into your gluestack project.
With this plugin, **Postgres** is added to your gluestack project as an instance.
29 changes: 0 additions & 29 deletions storybook/src/PluginDocs/PostgresPlugin/Goals/index.stories.mdx
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions storybook/src/PluginDocs/PostgresPlugin/How to Install/index.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
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';


<Meta title="Postgres Plugin/How to Install" />

# 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
Expand Down
87 changes: 0 additions & 87 deletions storybook/src/PluginDocs/PostgresPlugin/HowItWorks/index.stories.mdx
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion storybook/src/PluginDocs/PostgresPlugin/Requirements/index.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { Canvas, Meta, Story } from '@storybook/addon-docs';
<br/>

Postgres requires Backend-Engine plugin's instance to be installed.<br/>
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
```