From e5547f4289132cb6bf2c30c29d700628cc3fe8db Mon Sep 17 00:00:00 2001 From: eecavanna Date: Fri, 18 Aug 2023 13:52:17 -0700 Subject: [PATCH 1/3] Fix invalid ORCID Redirect URI in docs (#1041) --- docs/development.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/development.md b/docs/development.md index 230b08d6..f864e1bc 100644 --- a/docs/development.md +++ b/docs/development.md @@ -17,7 +17,8 @@ See `nmdc_server/config` for configuration. Env variable names begin with `NMDC 1. Create an OrcID account at orcid.org 1. Create an OrcID API Token in the [developer tools](https://orcid.org/developer-tools) -1. Set the redirect URIs to `http://localhost:8080` (Ignore the error about https, it's just a warning). +1. Set the Redirect URIs (the first and only one) to `http://127.0.0.1:8080` + - Note: OrcID has changed the validation logic for this form field over time. In case you run into validation errors, you may find [this issue](https://github.com/microbiomedata/nmdc-server/issues/1041) helpful. 1. Set the following configuration in `.env`, and then restart the stack. ```bash From 9195cfd03185e9d408a7cf2de4c670931a16fd14 Mon Sep 17 00:00:00 2001 From: eecavanna Date: Fri, 18 Aug 2023 14:55:25 -0700 Subject: [PATCH 2/3] Nest the Redirect URI step within previous step --- docs/development.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/development.md b/docs/development.md index f864e1bc..bfbc2251 100644 --- a/docs/development.md +++ b/docs/development.md @@ -17,8 +17,9 @@ See `nmdc_server/config` for configuration. Env variable names begin with `NMDC 1. Create an OrcID account at orcid.org 1. Create an OrcID API Token in the [developer tools](https://orcid.org/developer-tools) -1. Set the Redirect URIs (the first and only one) to `http://127.0.0.1:8080` - - Note: OrcID has changed the validation logic for this form field over time. In case you run into validation errors, you may find [this issue](https://github.com/microbiomedata/nmdc-server/issues/1041) helpful. + - Set the Redirect URIs (the first and only one) to `http://127.0.0.1:8080` + - Note: OrcID has changed the validation logic for this form field over time. + - In case you run into validation errors, you may find [this issue](https://github.com/microbiomedata/nmdc-server/issues/1041) helpful. 1. Set the following configuration in `.env`, and then restart the stack. ```bash From e18054c986422a0ec793f249e12a840a67866bb4 Mon Sep 17 00:00:00 2001 From: eecavanna Date: Fri, 18 Aug 2023 14:59:28 -0700 Subject: [PATCH 3/3] Refine instructions --- docs/development.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/development.md b/docs/development.md index bfbc2251..3ef6224c 100644 --- a/docs/development.md +++ b/docs/development.md @@ -15,11 +15,12 @@ Edit values in `.env` to point to existing postgresql databases. See `nmdc_server/config` for configuration. Env variable names begin with `NMDC_`. -1. Create an OrcID account at orcid.org -1. Create an OrcID API Token in the [developer tools](https://orcid.org/developer-tools) +1. Create an OrcID account at [orcid.org](https://orcid.org). +1. Create an Application via the OrcID [developer tools](https://orcid.org/developer-tools) page. - Set the Redirect URIs (the first and only one) to `http://127.0.0.1:8080` - Note: OrcID has changed the validation logic for this form field over time. - In case you run into validation errors, you may find [this issue](https://github.com/microbiomedata/nmdc-server/issues/1041) helpful. + - You will use the resulting **Client ID** and **Client Secret** in the next step. 1. Set the following configuration in `.env`, and then restart the stack. ```bash