square / square/shift

Improve Documentation

Open
#42 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
737
Forks
52
Avg merge
4d 4h
Merged PRs (30d)
1

Description

Hi,

I'm not seeing any detail configuration steps for this tool, I've updated following file

/home/ec2-user/shift/ui/config/database.yml

with local mysql credentials (but no host name) same EC2 where Shift is installed, I also update config.x.mysql_helper.db_config paramter with username & password in following file.

/home/ec2-user/shift/ui/config/environments/development.rb

now after run following command

"bundle exec rake db:setup"

and run server by issuing follwoing command

RAILS_ENV=production
rails server -b 0.0.0.0 -p 3000

I see databases in database drop down. Do I need to install Shift on same machine where my staging DB is located or how can I connect it to remote mysql host ? In my case its RDS.

Thank you

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing ui/config/database.yml and ui/config/environments/development.rb, then follow the reported bundle exec rake db:setup and Rails server commands. Document the required local and remote MySQL/RDS configuration, including how the host is specified, and verify that the database dropdown works with the documented setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
mysql, rails, ruby
Domain
databases, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.