Skip to content

Commit 470ad61

Browse files
Hou Chi ChanCopilot
andcommitted
docs: separate detailed single-region onboarding from technical reference
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 7204bc6 commit 470ad61

7 files changed

Lines changed: 485 additions & 264 deletions

File tree

‎README.md‎

Lines changed: 183 additions & 257 deletions
Large diffs are not rendered by default.

‎TECHNICAL.md‎

Lines changed: 293 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/ONBOARDING.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# EPP Onboarding
1+
# EPP Detailed Configuration and Validation
22

3-
Follow these five steps for the External Phone Provider (EPP) Function. Choose one language:
3+
For first-time single-region deployment, start with the [main onboarding guide](../README.md).
4+
This guide covers detailed configuration, local development, and validation of the External Phone
5+
Provider (EPP) Function. Choose one language:
46
[JavaScript](../javascript/README.md), [Python](../python/README.md), or [.NET](../dotnet/README.md).
57
Use [CONTRACT.md](CONTRACT.md) for the full request contract and production limitations.
68

@@ -123,8 +125,8 @@ Use [CONTRACT.md](CONTRACT.md) for the full request contract and production limi
123125
change signing keys; request a fresh token afterward. This does **not** disable the required
124126
JWE encryption of `encryptedDeliveryContext` or remove `EPP_DECRYPTION_KEY_PEM`.
125127

126-
Download the selected language's [Function ZIP](../README.md#download-a-function-zip) from GitHub
127-
Releases, or use the [root-level packaging scripts](../README.md#build-zips-locally) for custom builds.
128+
Download the selected language's [Function ZIP](../TECHNICAL.md#download-a-function-zip) from GitHub
129+
Releases, or use the [root-level packaging scripts](../TECHNICAL.md#build-zips-locally) for custom builds.
128130
The .NET source ZIP must be extracted and built/published with the .NET 8 SDK or a build-enabled
129131
deployment pipeline. The Python source ZIP requires Azure remote build on Linux. Neither source
130132
ZIP is ready for direct run-from-package. Downloading or building a ZIP does not deploy it.
147 KB
Loading

‎dotnet/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ matching provider authentication settings to `Values`.
5555
Add `EPP_PROVIDER_ACCOUNT_NAME` and adapter-specific options only when required. Optional
5656
`EPP_PROVIDER_TIMEOUT_MS` is a string such as `"1500"`. Replace placeholders; store provider credentials
5757
under the adapter's Key Vault secret names, not in local settings. See the
58-
[complete variable table](../README.md#configure-environment-variables).
58+
[complete variable table](../TECHNICAL.md#configure-environment-variables).
5959

6060
Core Tools loads `Values` into environment variables. [AppConfig.Read](Src/AppConfig.cs) reads them
6161
through `IEnv`; direct worker execution and unit tests do not automatically load local settings.

‎javascript/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ For live delivery, add `EPP_PROVIDER_NAME`, the complete selected `EPP_PROVIDER_
5050
matching provider authentication settings to `Values`.
5151
Add `EPP_PROVIDER_ACCOUNT_NAME` and any adapter-specific options only when required. Optional
5252
`EPP_PROVIDER_TIMEOUT_MS` is a string such as `"1500"`. Replace placeholders; do not put API keys in
53-
this file. See the [complete variable table](../README.md#configure-environment-variables).
53+
this file. See the [complete variable table](../TECHNICAL.md#configure-environment-variables).
5454

5555
Core Tools copies `Values` into the process environment; direct Node processes and the offline tests
5656
do **not** automatically load this file. [AppConfig](src/functions/config.js) reads `process.env`

‎python/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ matching provider authentication settings to `Values`.
5050
Add `EPP_PROVIDER_ACCOUNT_NAME` and any adapter-specific options only when required. Keep values as
5151
strings, including optional `EPP_PROVIDER_TIMEOUT_MS: "1500"`. Replace placeholders; provider API
5252
keys belong in the manifest-named Key Vault secrets, not this file. See the
53-
[complete variable table](../README.md#configure-environment-variables).
53+
[complete variable table](../TECHNICAL.md#configure-environment-variables).
5454

5555
Core Tools loads `Values` into `os.environ`. Direct Python execution and pytest do not automatically
5656
read local settings. [read_config](src/config.py) returns an `AppConfig` object; the handler/engine

0 commit comments

Comments
 (0)