feat: Add runbook (#120)

feat: Add runbook

README.md

@@ -6,18 +6,14 @@
 
 ## Spine Datasheet
 
-- Product owner: 
+- Product owner: [Monica Myklebust Polden](mailto:[email protected])
 - Business area: 
 
 ## Summary Description
 
-Lorem ipsum dolor sit amet. Qui consequuntur repudiandae et tempore modi ut cumque Quis id veniam sint ea perspiciatis quasi et Quis voluptatem qui architecto explicabo. Ex fugiat quia et quam dolores et minima omnis a illo dolor. Non assumenda saepe sed quia tempore qui dolorem molestias et laudantium praesentium id molestiae ipsa. Eum quam eaque in corrupti delectus ut adipisci distinctio 33 omnis accusamus.
+Datasheet is a Fusion application that lets the user view datasheets and review tag data from Spine.
 
-### Prerequisites
-
-- [.NET 6.0+](https://dotnet.microsoft.com/download/dotnet/6.0)
-- [Node 16+ with npm 8+](https://github.com/nodesource/distributions/blob/master/README.md)
-- [Docker](https://docs.docker.com/engine/install/)
+## [Runbook](https://github.com/equinor/spinedatasheetapi/blob/main/documentation/runbook.md)
 
 ## Architechture
 
@@ -43,31 +39,6 @@ Configuration of the required infrastructure is placed in a radixconfig.yml, whi
 
 The backend is dotnet webapi built with .NET 6 which provides a REST interface for the frontend. Swagger has been installed to provide documentation for the API, and to test functions. The backend retrieves and stores data in a Azure SQL Database for each environment. 
 
-### Run backend
-
-Create a file `backend/api/Properties/launchSettings.json` with the provided
-template file. You need to populate the app configuration connection string
-(navigate to azure portal, find app configuration resource, navigate to
-settings -> access keys), and choose an AppConfiguration Environment (`dev` for
-local development at time of writing).
-
-Finally, to be able to use secrets referenced in the app config, you need to
-authenticate yourself on the command line. [Get a hold of the azure CLI
-`az`](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) and run `az login` in the command line. NB: You will need to use a browser for the
-authentication, as far as I know.
-
-Then, to start the backend, you can run
-
-```cmd
-cd backend/api
-dotnet run
-```
-
-## Deployment
-
-We have 3 different environments in use; dev, qa and prod. Dev is built
-when pull requests are merged to main. 
-
 ## Development
 
 ### Team

documentation/runbook.md

@@ -0,0 +1,43 @@
+# Runbook for Spine Datasheet
+
+### Prerequisites
+
+- [.NET 6.0+](https://dotnet.microsoft.com/download/dotnet/6.0)
+- [Node 16+ with npm 8+](https://github.com/nodesource/distributions/blob/master/README.md)
+- [Docker](https://docs.docker.com/engine/install/)
+
+### Run backend
+
+Run backend from [spinedatasheetapi](https://github.com/equinor/spinedatasheetapi) repo.
+
+Create a file `backend/api/Properties/launchSettings.json` with the provided
+template file. You need to populate the app configuration connection string
+(navigate to azure portal, find app configuration resource, navigate to
+settings -> access keys), and choose an AppConfiguration Environment (`dev` for
+local development at time of writing).
+
+Finally, to be able to use secrets referenced in the app config, you need to
+authenticate yourself on the command line. [Get a hold of the azure CLI
+`az`](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) and run `az login` in the command line. NB: You will need to use a browser for the
+authentication, as far as I know.
+
+Then, to start the backend, you can run
+
+```cmd
+cd datasheetapi
+dotnet run
+```
+
+### Run frontend
+
+Run frontend from [spinedatasheetweb](https://github.com/equinor/spinedatasheetweb) repo.
+
+```cmd
+yarn install
+yarn start
+```
+
+## Deployment
+
+We have 3 different environments in use; dev, qa and prod. Dev is built
+when pull requests are merged to main.