From a7e8ab6c6cb05fbec2eb98786a0147f155763d62 Mon Sep 17 00:00:00 2001 From: Russ Poetker Date: Wed, 5 Jun 2024 16:02:45 -0400 Subject: [PATCH] Clean doc --- README.md | 5 +++-- invenio-rdm/README.md | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b9e2b98..b0f24d3 100644 --- a/README.md +++ b/README.md @@ -35,13 +35,14 @@ docker compose -p pass-docker -f dspace-cli.yml -f dspace-cli.ingest.yml run --r ### Run With Deposit Services and InvenioRDM In order to run a local instance **_with_** deposit-service, ftp, InvenioRDM, you can run: -First, you need to start the local test InvenioRDM in the `invenio-rdm` directory: +Refer to [invenio-rdm/README](./invenio-rdm/README.md) to ensure the prerequisites are met before running the commands below. + +First, start the local test InvenioRDM by running the following command in the `invenio-rdm` directory: ```console ./build.sh ./start.sh ``` -Refer to invenio-rdm/README to ensure the prerequisites are met before running the commands above. After the InvenioRDM service is up and running, run the following commands in the `pass-docker` directory: diff --git a/invenio-rdm/README.md b/invenio-rdm/README.md index d9d03db..ac68746 100644 --- a/invenio-rdm/README.md +++ b/invenio-rdm/README.md @@ -1,6 +1,6 @@ # Test InvenioRDM -This is a test InvenioRDM instance that can be run locally for testing. +This is a InvenioRDM instance that can be run locally for testing. **Note**: This is only intended for local testing and is not meant for Production use. @@ -12,7 +12,7 @@ The `pass-docker-invenio-rdm` directory was created following these instructions - You must have Python v3.8 or greater installed. - You must have the `invenio-cli` python tool installed and available in your PATH. https://inveniordm.docs.cern.ch/install/cli/ -Run the following commands in order to start your new InvenioRDM instance: +Run the following commands in order to start the InvenioRDM instance: ```console ./build.sh @@ -30,7 +30,7 @@ Once running, visit https://127.0.0.1 in your browser. **Note**: The server is using a self-signed SSL certificate, so your browser will issue a warning that you will have to by-pass. -To Stop InvenioRDM, run the following commands: +To stop the InvenioRDM instance, run the following commands: ```console ./stop.sh