[Documentation] RB refresh script instructions added to RB Readme #6535
Conversation
AlexandraLivadas
added
23.0.0-testing
Bug
There was a problem hiding this comment.
lgtm! thanks @AlexandraLivadas
will request a review from rida/john/dave
christinerogers
added
the
Passed Manual Tests
raisinbread/README.md
Outdated
| @@ -29,6 +29,16 @@ that is not the case, replace all `mysql` commands below by the necessary values | |||
| `mysql -u user -p -h host database_name`* | |||
|
|
|||
| ##### Sourcing SQL | |||
| The script `tools/raisinbread_refresh.php` includes functionality that drops all existing tables in the | |||
There was a problem hiding this comment.
I'm okai with this addition however I don't think it belongs under the Sourcing SQL header. This script does so much more than just sourcing the SQL. It actually replaces pretty much this entire readme.
I think we should instead divide the Installing RB header into 2 sections. automated and manual instructions and make it clear to users that you should pick or the other to install it.
There was a problem hiding this comment.
I can make this change to the formatting. For developers who are first sourcing RB though, they also need to make the steps in the following section "Configuring", which isn't done by this script. I'll try to make this clear.
raisinbread/README.md
Outdated
| root directory and run the following command: | ||
|
|
||
| ```bash | ||
| ./tools/raisinbread_refresh.php |
There was a problem hiding this comment.
The script can also be run using make testdata which is probably a little more clear.
raisinbread/README.md
Outdated
| @@ -29,6 +29,16 @@ that is not the case, replace all `mysql` commands below by the necessary values | |||
| `mysql -u user -p -h host database_name`* | |||
|
|
|||
| ##### Sourcing SQL | |||
| The script `tools/raisinbread_refresh.php` includes functionality that drops all existing tables in the | |||
| database and sources all of the RaisinBread data automatically. To run this script, navigate to the LORIS | |||
There was a problem hiding this comment.
I think ti would be useful to add a note here to the effect of "The script will preserve database settings such as API Keys and server configuration settings to simplify the process of switching between development environments.
|
Due to the above linked PR by @johnsaigle , I will remove the latest change in the Readme that instructs users to install instruments themselves when using the |
raisinbread/README.md
Outdated
| ``` | ||
|
|
||
| If RaisinBread is being installed for the first time, the steps outlined below in the | ||
| [Configuring](https://github.com/aces/Loris/tree/23.0-release/raisinbread#configuring) section must be completed. |
There was a problem hiding this comment.
It might be better to not use a hyperlink here because we'll have to update the version info in the link every release.
Co-authored-by: John Saigle <4022790+johnsaigle@users.noreply.github.com>
raisinbread/README.md
Outdated
| ``` | ||
|
|
||
| If RaisinBread is being installed for the first time, the steps outlined below in the | ||
| _Configuring_ section must be completed. |
There was a problem hiding this comment.
since "Configuring" is a header, you could use a in-file link to it instead of italics
Instructions on using the
/tools/raisinbread_refresh.phpscript to source RB data added to the RaisinBread README for the 23.0-release.