Skip to content
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.

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

fix: Reword database cli prompts for clarity #123

Conversation

deloristhompson
Copy link
Contributor

@deloristhompson deloristhompson commented Dec 31, 2020

Reword database cli prompts

Changes

  • Adds a prefix to each prompt

Screenshots

Screen Shot 2020-12-31 at 10 43 14 AM

Checklist

n/a

Fixes Issue47

docs/homebrewPostgresInstructions.md Outdated Show resolved Hide resolved
@@ -54,35 +55,40 @@ function generateQuestions(appName) {
{
name: "db.dev.name",
type: "input",
message: "What is the local database name?",
prefix: "The following link <link> will help you setup a new Postgres database if needed.\n\bThe name you will use for the new database (or current).\n",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about asking if they have Postgres setup first?

Do you have Postgres setup? y/n

(If the user answers no)

Visit https://github.com/echobind/bisonapp/blob/main/docs/postgres.md for instructions!

(If the user answers yes, prompt for the database info below).

I like that you added both Homebrew and Postgres.app docs. Could we create a parent Postgres doc that links to each of those? That way, we can point users to a single place and they can choose how to proceed.

@deloristhompson deloristhompson changed the title Reword database cli prompts for clarity feat: Reword database cli prompts for clarity Jan 6, 2021
@deloristhompson deloristhompson changed the title feat: Reword database cli prompts for clarity fix: Reword database cli prompts for clarity Jan 6, 2021
## Installing PostgreSQL

1. Install using hombrew: `brew install postgres`
2. Add a local user (we recommend creating as a superuser to keep setup simple): `create user postgres --superuser`
Copy link

@mcavaliere mcavaliere Sep 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't the user called postgres exist by default? Either way I recommend calling it something different.

@@ -0,0 +1,31 @@
# Postgres.app (Mac Only)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are great!


## Operating Systems:

macOS

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a bulleted list maybe?


## What is included:

PostgreSQL Server

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This area looks like it could use some formatting

description: "The database host",
default: "localhost",
},
{
name: "db.dev.port",
type: "input",
message: "What is the local database port?",
prefix: "The port you will use for the new database (or current).\n",
message: `${chalk.green("\b?")} Local database port`,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 looking good

Copy link

@mcavaliere mcavaliere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved so this doesn't block merging, but the formatting and postgres comments are worth resolving.

@cball
Copy link
Member

cball commented Nov 5, 2021

We're going to be revisiting the CLI prompts / questions.

@cball cball closed this Nov 5, 2021
@cball cball deleted the deloris/issue47/reword-database-cli-prompts-for-clarity branch November 5, 2021 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

reword database cli prompts for clarity
3 participants