From 99a2095d8d53d232abe659a06d516ce6fecd5fd0 Mon Sep 17 00:00:00 2001 From: James Friel Date: Mon, 18 Dec 2023 13:51:10 +0000 Subject: [PATCH 1/7] add stub file --- Documentation/Quickstart.md | 0 README.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 Documentation/Quickstart.md diff --git a/Documentation/Quickstart.md b/Documentation/Quickstart.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/README.md b/README.md index eed084e4eb..6b4e411f75 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # ![logo](./Application/ResearchDataManagementPlatform/Icon/mainsmall.png)Research Data Management Platform [![Build status](https://github.com/HicServices/RDMP/workflows/Build/badge.svg)](https://github.com/HicServices/RDMP/actions?query=workflow%3ABuild) [![Total alerts](https://img.shields.io/lgtm/alerts/g/HicServices/RDMP.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/HicServices/RDMP/alerts/) [![NuGet Badge](https://buildstats.info/nuget/HIC.RDMP.Plugin)](https://www.nuget.org/packages/HIC.RDMP.Plugin) [![Coverage Status](https://coveralls.io/repos/github/HicServices/RDMP/badge.svg?branch=develop)](https://coveralls.io/github/HicServices/RDMP?branch=develop) - - [Demo Video](https://www.youtube.com/watch?v=Fgi9-Sdup-Y) - [Releases](https://github.com/HicServices/RDMP/releases) +- [Quickstart](Documentation/Quickstart.md) - [FAQ](Documentation/CodeTutorials/FAQ.md) - [User Manual](./Documentation/CodeTutorials/UserManual.md) - [Glossary](./Documentation/CodeTutorials/Glossary.md) From d8157bfc5b366f0055afd3eb5d27a04634f0be99 Mon Sep 17 00:00:00 2001 From: James Friel Date: Mon, 18 Dec 2023 14:22:40 +0000 Subject: [PATCH 2/7] add win instructions --- Documentation/Quickstart.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/Documentation/Quickstart.md b/Documentation/Quickstart.md index e69de29bb2..6f6c50fe5c 100644 --- a/Documentation/Quickstart.md +++ b/Documentation/Quickstart.md @@ -0,0 +1,19 @@ +# RDMP Quickstart Guide +## Prerequisites +- Access to an SQL Server + - This is used for RDMPs internal starage + - Any SQL Server will do, such as SQL Server Express + +## Steps for Windows GUI Client +1. Download the latest release of RDMP from [GitHub](https://github.com/HicServices/RDMP/releases/latest). It will be called something like `rdmp-8.0.0-client.zip` +2. Unzip this file +3. Inside this folder you should find and run a file called `ResearchDataManagmentPlatform.exe` +4. You should be prompted to input your platform databases + * Set the server name, if you're using a locally hosted SQL server this will be something like `localhost\sqlexpress` + * Set any login credentials required to access your database + * If you want some fake data to test RDMP with, check the `Example Datasets` checkbox + * All other options are for more advanced configurations, check out the [User Manual](./CodeTutorials/UserManual.md) for details +5. Press the `Create` button + RDMP will now create the platform databases it requires. Any issues will be flagged in the results table. +6. RDMP will now restart, allow it to do its thing +7. Congratualtions, you've successfully set up RDMP. Explore RDMP with your fake data, or check out the [User Manual](./CodeTutorials/UserManual.md) for more info on what RDMP can do. From b51c18e53f0a84db3e9210dd294aefd78e61c889 Mon Sep 17 00:00:00 2001 From: James Friel Date: Mon, 18 Dec 2023 14:52:19 +0000 Subject: [PATCH 3/7] add cli instructions and test ignore --- Documentation/Quickstart.md | 12 +++++++++++- .../DocumentationCrossExaminationTest.cs | 5 ++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/Documentation/Quickstart.md b/Documentation/Quickstart.md index 6f6c50fe5c..2b286248d3 100644 --- a/Documentation/Quickstart.md +++ b/Documentation/Quickstart.md @@ -16,4 +16,14 @@ 5. Press the `Create` button RDMP will now create the platform databases it requires. Any issues will be flagged in the results table. 6. RDMP will now restart, allow it to do its thing -7. Congratualtions, you've successfully set up RDMP. Explore RDMP with your fake data, or check out the [User Manual](./CodeTutorials/UserManual.md) for more info on what RDMP can do. +7. Congratualtions, you've successfully set up RDMP. Explore RDMP with your fake data, or check out the [User Manual](./CodeTutorials/UserManual.md) for more info on what RDMP can do. + + +## Steps for CLI +1. Download the latest release of RDMP from [GitHub](https://github.com/HicServices/RDMP/releases/latest). It will be called something like `rdmp-8.1.1-cli-win-x64.zip` for windows and `rdmp-8.1.1-cli-linux-x64.zip` for linux +2. Unzip this file +3. Inside this folder you should finda file called`rdmp.exe`. Run the command `rdmp.exe install "{YOUR_SQL_SERVER_CONNECTION_STRING}" RDMP_ -e` + * Replace `YOUR_SQL_SERVER_CONNECTION_STRING` with the connection string to your SQL Server + * An example of this would be `localhost\sqlexpress;Uid=user;Pwd=password` + * This command creates the platform databases RDMP requires. Any issues will appear in stdout +4. Congratualtions, you've successfully set up RDMP using the CLI. Check out the [User Manual](./CodeTutorials/UserManual.md) for more info on what RDMP can do. diff --git a/Rdmp.UI.Tests/DesignPatternTests/ClassFileEvaluation/DocumentationCrossExaminationTest.cs b/Rdmp.UI.Tests/DesignPatternTests/ClassFileEvaluation/DocumentationCrossExaminationTest.cs index 67805eb1c9..f9f5c92202 100644 --- a/Rdmp.UI.Tests/DesignPatternTests/ClassFileEvaluation/DocumentationCrossExaminationTest.cs +++ b/Rdmp.UI.Tests/DesignPatternTests/ClassFileEvaluation/DocumentationCrossExaminationTest.cs @@ -275,7 +275,10 @@ internal class DocumentationCrossExaminationTest "MakeAnonymous", "ReleaseIdentifierAllocation", "SocialSecurityNumber", - "BuildInParallel" + "BuildInParallel", + + //Quickstart.ms + "ResearchDataManagmentPlatform" }; #endregion From dfe229a078066b1281e24a92840b1d6ef4371246 Mon Sep 17 00:00:00 2001 From: James Friel Date: Mon, 18 Dec 2023 15:01:43 +0000 Subject: [PATCH 4/7] add updated instructions --- Documentation/Quickstart.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Documentation/Quickstart.md b/Documentation/Quickstart.md index 2b286248d3..80dbb0914d 100644 --- a/Documentation/Quickstart.md +++ b/Documentation/Quickstart.md @@ -8,15 +8,16 @@ 1. Download the latest release of RDMP from [GitHub](https://github.com/HicServices/RDMP/releases/latest). It will be called something like `rdmp-8.0.0-client.zip` 2. Unzip this file 3. Inside this folder you should find and run a file called `ResearchDataManagmentPlatform.exe` -4. You should be prompted to input your platform databases +4. You will be prompted with two buttons, select the `I want to create new Platform Databases` option +5. You should be prompted to input your platform databases * Set the server name, if you're using a locally hosted SQL server this will be something like `localhost\sqlexpress` * Set any login credentials required to access your database * If you want some fake data to test RDMP with, check the `Example Datasets` checkbox * All other options are for more advanced configurations, check out the [User Manual](./CodeTutorials/UserManual.md) for details -5. Press the `Create` button +6. Press the `Create` button RDMP will now create the platform databases it requires. Any issues will be flagged in the results table. -6. RDMP will now restart, allow it to do its thing -7. Congratualtions, you've successfully set up RDMP. Explore RDMP with your fake data, or check out the [User Manual](./CodeTutorials/UserManual.md) for more info on what RDMP can do. +7. RDMP will now restart, allow it to do its thing +8. Congratualtions, you've successfully set up RDMP. Explore RDMP with your fake data, or check out the [User Manual](./CodeTutorials/UserManual.md) for more info on what RDMP can do. ## Steps for CLI From 015909815d20198c13b27b8c0ad6a4b217ec243f Mon Sep 17 00:00:00 2001 From: James Friel Date: Mon, 18 Dec 2023 15:31:33 +0000 Subject: [PATCH 5/7] fix spelling --- Documentation/Quickstart.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/Quickstart.md b/Documentation/Quickstart.md index 80dbb0914d..e4f31a5374 100644 --- a/Documentation/Quickstart.md +++ b/Documentation/Quickstart.md @@ -1,7 +1,7 @@ # RDMP Quickstart Guide ## Prerequisites - Access to an SQL Server - - This is used for RDMPs internal starage + - This is used for RDMPs internal storage - Any SQL Server will do, such as SQL Server Express ## Steps for Windows GUI Client @@ -17,14 +17,14 @@ 6. Press the `Create` button RDMP will now create the platform databases it requires. Any issues will be flagged in the results table. 7. RDMP will now restart, allow it to do its thing -8. Congratualtions, you've successfully set up RDMP. Explore RDMP with your fake data, or check out the [User Manual](./CodeTutorials/UserManual.md) for more info on what RDMP can do. +8. Congratulations, you've successfully set up RDMP. Explore RDMP with your fake data, or check out the [User Manual](./CodeTutorials/UserManual.md) for more info on what RDMP can do. ## Steps for CLI 1. Download the latest release of RDMP from [GitHub](https://github.com/HicServices/RDMP/releases/latest). It will be called something like `rdmp-8.1.1-cli-win-x64.zip` for windows and `rdmp-8.1.1-cli-linux-x64.zip` for linux 2. Unzip this file -3. Inside this folder you should finda file called`rdmp.exe`. Run the command `rdmp.exe install "{YOUR_SQL_SERVER_CONNECTION_STRING}" RDMP_ -e` +3. Inside this folder you should find a file called`rdmp.exe`. Run the command `rdmp.exe install "{YOUR_SQL_SERVER_CONNECTION_STRING}" RDMP_ -e` * Replace `YOUR_SQL_SERVER_CONNECTION_STRING` with the connection string to your SQL Server * An example of this would be `localhost\sqlexpress;Uid=user;Pwd=password` * This command creates the platform databases RDMP requires. Any issues will appear in stdout -4. Congratualtions, you've successfully set up RDMP using the CLI. Check out the [User Manual](./CodeTutorials/UserManual.md) for more info on what RDMP can do. +4. Congratulations, you've successfully set up RDMP using the CLI. Check out the [User Manual](./CodeTutorials/UserManual.md) for more info on what RDMP can do. From 28e1f415cea8afbdf86b5862777a4b31da6efb36 Mon Sep 17 00:00:00 2001 From: James Friel Date: Mon, 18 Dec 2023 15:40:00 +0000 Subject: [PATCH 6/7] update changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d901fec926..299f0f94d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Add command to dump current platform DB to directory - Reorder Process Task Enum order to restore old cached process tasks +- Add quickstart instrctions ## [8.1.1] - 2023-12-01 From 69b45219f734666d068137d8fd57902cc8bc1920 Mon Sep 17 00:00:00 2001 From: James A Sutherland <> Date: Mon, 18 Dec 2023 17:59:13 -0600 Subject: [PATCH 7/7] Fix typos, note alternative to MS SQL Server in Quickstart --- CHANGELOG.md | 2 +- Documentation/Quickstart.md | 10 +++++----- .../DocumentationCrossExaminationTest.cs | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 299f0f94d1..a43f5fc250 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Add command to dump current platform DB to directory - Reorder Process Task Enum order to restore old cached process tasks -- Add quickstart instrctions +- Add quickstart instructions ## [8.1.1] - 2023-12-01 diff --git a/Documentation/Quickstart.md b/Documentation/Quickstart.md index e4f31a5374..fa36905b67 100644 --- a/Documentation/Quickstart.md +++ b/Documentation/Quickstart.md @@ -1,13 +1,13 @@ # RDMP Quickstart Guide ## Prerequisites -- Access to an SQL Server - - This is used for RDMPs internal storage - - Any SQL Server will do, such as SQL Server Express +- Access to an installation of Microsoft SQL Server, _or_ ability to run RDMP from the command line + - SQL Server is used for RDMPs internal storage, or a directory on disk can be used instead + - Any SQL Server edition will do, such as SQL Server Express (free) ## Steps for Windows GUI Client 1. Download the latest release of RDMP from [GitHub](https://github.com/HicServices/RDMP/releases/latest). It will be called something like `rdmp-8.0.0-client.zip` 2. Unzip this file -3. Inside this folder you should find and run a file called `ResearchDataManagmentPlatform.exe` +3. Inside this folder you should find and run a file called `ResearchDataManagmentPlatform.exe`. Run this file with the `--dir` switch, followed by a location to use for storage, such as `ResearchDataManagmentPlatform.exe -dir d:\rdmpdata`. _OR_ 4. You will be prompted with two buttons, select the `I want to create new Platform Databases` option 5. You should be prompted to input your platform databases * Set the server name, if you're using a locally hosted SQL server this will be something like `localhost\sqlexpress` @@ -23,7 +23,7 @@ ## Steps for CLI 1. Download the latest release of RDMP from [GitHub](https://github.com/HicServices/RDMP/releases/latest). It will be called something like `rdmp-8.1.1-cli-win-x64.zip` for windows and `rdmp-8.1.1-cli-linux-x64.zip` for linux 2. Unzip this file -3. Inside this folder you should find a file called`rdmp.exe`. Run the command `rdmp.exe install "{YOUR_SQL_SERVER_CONNECTION_STRING}" RDMP_ -e` +3. Inside this folder you should find a file called `rdmp.exe` (for Windows) or `rdmp` (Linux). Run it as `rdmp.exe --dir d:\rdmpdata` (where d:\rdmpdata is where you want to store RDMP internal data), or if you prefer MS SQL Server, run the command `rdmp.exe install "{YOUR_SQL_SERVER_CONNECTION_STRING}" RDMP_ -e` * Replace `YOUR_SQL_SERVER_CONNECTION_STRING` with the connection string to your SQL Server * An example of this would be `localhost\sqlexpress;Uid=user;Pwd=password` * This command creates the platform databases RDMP requires. Any issues will appear in stdout diff --git a/Rdmp.UI.Tests/DesignPatternTests/ClassFileEvaluation/DocumentationCrossExaminationTest.cs b/Rdmp.UI.Tests/DesignPatternTests/ClassFileEvaluation/DocumentationCrossExaminationTest.cs index f9f5c92202..0c116136cd 100644 --- a/Rdmp.UI.Tests/DesignPatternTests/ClassFileEvaluation/DocumentationCrossExaminationTest.cs +++ b/Rdmp.UI.Tests/DesignPatternTests/ClassFileEvaluation/DocumentationCrossExaminationTest.cs @@ -277,7 +277,7 @@ internal class DocumentationCrossExaminationTest "SocialSecurityNumber", "BuildInParallel", - //Quickstart.ms + //Quickstart.md "ResearchDataManagmentPlatform" }; @@ -543,4 +543,4 @@ private void EnsureMaximumGlossaryUse(string mdFile, List problems) File.AppendAllLines(mdFile, suggestedLinks.Values.Distinct()); } } -} \ No newline at end of file +}