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

Add rails dbconsole #10861

Merged
merged 2 commits into from Oct 16, 2020
Merged

Add rails dbconsole #10861

merged 2 commits into from Oct 16, 2020

Conversation

ShubhankarKG
Copy link
Contributor

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

Adds rails dbconsole to open up database terminal, and explains why it is a better alternative.

Related Tickets & Documents

Fixes #10843

QA Instructions, Screenshots, Recordings

Screenshot from 2020-10-15 13-43-37

Added tests?

  • yes
  • no, because they aren't needed
  • no, because I need help

Added to documentation?

  • docs.forem.com
  • readme
  • no documentation needed

@ShubhankarKG ShubhankarKG requested a review from a team October 15, 2020 08:37
@pr-triage pr-triage bot added the PR: unreviewed bot applied label for PR's with no review label Oct 15, 2020
Copy link
Contributor

@jacobherrington jacobherrington left a comment

Choose a reason for hiding this comment

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

Thanks for improving the docs! I like this idea, I had a quick question that I left as a comment. 😄

terminal.

> Note: dbconsole reads database information from config/database.yml which is
> always better since database configs might change in the future.
Copy link
Contributor

Choose a reason for hiding this comment

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

I like the spirit of explaining this, but can we move this down beneath the list of steps? I think the break from the steps is a bit confusing.

What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Totally agreed with breaking the flow from an user perspective. The note stands there to explain why we want users to go to the first alternative, but it didn't strike me that as an user, I can read the note later as well. I'll update this in the next commit.

Copy link
Contributor

@jacobherrington jacobherrington left a comment

Choose a reason for hiding this comment

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

I think this is an improvement! Thanks for making this PR @ShubhankarKG, we always appreciate improvements to the documentation. 📜 👍

@pr-triage pr-triage bot added PR: partially-approved bot applied label for PR's where a single reviewer approves changes and removed PR: unreviewed bot applied label for PR's with no review labels Oct 16, 2020
@pr-triage pr-triage bot added PR: reviewed-approved bot applied label for PR's where reviewer approves changes and removed PR: partially-approved bot applied label for PR's where a single reviewer approves changes labels Oct 16, 2020
@benhalpern benhalpern merged commit fccb866 into forem:master Oct 16, 2020
@pr-triage pr-triage bot added PR: merged bot applied label for PR's that are merged and removed PR: reviewed-approved bot applied label for PR's where reviewer approves changes labels Oct 16, 2020
@ShubhankarKG ShubhankarKG deleted the docs branch October 17, 2020 07:14
boardfish pushed a commit to boardfish/forem that referenced this pull request Oct 17, 2020
* Add rails dbconsole

* Transfer note at bottom of steps as in PR comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: merged bot applied label for PR's that are merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add rails dbconsole command to the documentation
3 participants