Skip to content

Commit ef848b0

Browse files
authored
Chore: update docs links (#982)
### What Change Links to the developer documentation. Also went through other links to the docs site, and updated old links to new locations, where necessary. ### Why I moved some of the platform docs around (with redirects), and wanted to update the source links, as well.
1 parent a5b0ccd commit ef848b0

File tree

6 files changed

+48
-41
lines changed

6 files changed

+48
-41
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Swagger Documentation](https://img.shields.io/badge/docs-swagger-blue?logo=swagger)](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/stellar/stellar-docs/refs/heads/main/openapi/stellar-disbursement-platform/bundled.yaml)
44
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/stellar/stellar-disbursement-platform-backend)
5-
[![Stellar Docs](https://img.shields.io/badge/docs-stellar.org-blue?logo=stellar)](https://developers.stellar.org/platforms/stellar-disbursement-platform)
5+
[![Stellar Docs](https://img.shields.io/badge/docs-stellar.org-blue?logo=stellar)](https://developers.stellar.org/docs/platforms/stellar-disbursement-platform)
66
[![CI](https://img.shields.io/github/check-runs/stellar/stellar-disbursement-platform-backend/develop?logo=github&label=CI)](https://github.com/stellar/stellar-disbursement-platform-backend/actions/workflows/docker_image_public_release.yml)
77
[![Go Report Card](https://goreportcard.com/badge/github.com/stellar/stellar-disbursement-platform-backend)](https://goreportcard.com/report/github.com/stellar/stellar-disbursement-platform-backend)
88
[![GitHub](https://img.shields.io/github/license/stellar/stellar-disbursement-platform-backend)](https://github.com/stellar/stellar-disbursement-platform-backend/blob/main/LICENSE)
@@ -25,8 +25,8 @@
2525
- [State Transitions](#state-transitions)
2626

2727
> [!NOTE]
28-
> If you are using version 1.x.x, we highly recommend upgrading to version 2.x.x to benefit from the latest features, routine fixes, and security patches.
29-
> For detailed instructions on how to upgrade, please refer to [the upgrade guide](https://developers.stellar.org/network/stellar-disbursement-platform/admin-guide/single-tenant-to-multi-tenant-migration).
28+
> If you are using version 1.x.x, we highly recommend upgrading to version 2.x.x to benefit from the latest features, routine fixes, and security patches.
29+
> For detailed instructions on how to upgrade, please refer to [the upgrade guide](https://developers.stellar.org/docs/platforms/stellar-disbursement-platform/admin-guide/single-tenant-to-multi-tenant-migration).
3030
3131
## Introduction
3232

@@ -47,7 +47,7 @@ stellar-disbursement-platform --help
4747

4848
## Quick Start
4949

50-
### Docker Compose
50+
### Docker Compose
5151

5252
To quickly test the SDP using preconfigured values, use the startup wizard.
5353

@@ -57,7 +57,7 @@ make setup
5757

5858
For more information about launching and configuring the SDP, see the [Quick Start Guide](./dev/README.md).
5959

60-
### Helm
60+
### Helm
6161

6262
To deploy the SDP using Helm, see the [Helm Chart](./helmchart/sdp/README.md).
6363

@@ -178,7 +178,7 @@ The SEP10/SEP24 implementation can be configured using the following environment
178178
SEP10_SIGNING_PUBLIC_KEY=G... # Public key for SEP10 signing
179179
SEP10_SIGNING_PRIVATE_KEY=S... # Private key for SEP10 signing
180180

181-
# SEP24 Configuration
181+
# SEP24 Configuration
182182
SEP24_JWT_SECRET=jwt_secret_... # JWT secret for SEP24 tokens
183183
```
184184

@@ -190,7 +190,7 @@ The following environment variables are required for SEP10/SEP24 functionality:
190190

191191
**Required Variables:**
192192
- `SEP10_SIGNING_PUBLIC_KEY` - Public key for SEP10 challenge signing
193-
- `SEP10_SIGNING_PRIVATE_KEY` - Private key for SEP10 challenge signing
193+
- `SEP10_SIGNING_PRIVATE_KEY` - Private key for SEP10 challenge signing
194194
- `SEP24_JWT_SECRET` - JWT secret for SEP24 token signing
195195

196196
**Optional Variables:**
@@ -207,9 +207,9 @@ The SDP Core service include several components started using a single command.
207207
stellar-disbursement-platform serve --help
208208
```
209209

210-
#### Admin API
210+
#### Admin API
211211

212-
The Admin API is the component responsible for managing tenants of the SDP. It runs by default on port 8003 and is used to provision new tenants and manage existing tenants.
212+
The Admin API is the component responsible for managing tenants of the SDP. It runs by default on port 8003 and is used to provision new tenants and manage existing tenants.
213213

214214
#### Dashboard API
215215

@@ -273,7 +273,7 @@ TWILIO_WHATSAPP_RECEIVER_OTP_TEMPLATE_SID=HXxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
273273
- WhatsApp requires pre-approved message templates for all business-initiated conversations
274274
- Template variables are automatically populated by the SDP based on the message type
275275
- All templates must be approved by WhatsApp before they can be used in production
276-
- For detailed setup instructions, refer to the [Twilio WhatsApp API documentation](https://www.twilio.com/docs/whatsapp/api)
276+
- For detailed setup instructions, refer to the [Twilio WhatsApp API documentation](https://www.twilio.com/docs/whatsapp/api)
277277

278278
#### Wallet Registration UI
279279

@@ -308,7 +308,7 @@ In future iterations of the project, the Transaction Submission Service will pro
308308

309309
To manage the migrations of the database, use the `db` subcommand.
310310

311-
####
311+
####
312312

313313
```sh
314314
stellar-disbursement-platform db --help
@@ -322,7 +322,7 @@ stellar-disbursement-platform db --help
322322
stellar-disbursement-platform db admin migrate up
323323
```
324324

325-
The tables below are used to manage tenants and their configurations.
325+
The tables below are used to manage tenants and their configurations.
326326

327327
![admin schema](./docs/images/admin_db_schema.png)
328328

@@ -371,8 +371,8 @@ The SDP uses Background jobs to handle asynchronous tasks.
371371

372372
**1. Jobs**
373373

374-
> [!NOTE]
375-
> Certain jobs are not listed here because they cannot be configured and are necessary to the functioning of the SDP.
374+
> [!NOTE]
375+
> Certain jobs are not listed here because they cannot be configured and are necessary to the functioning of the SDP.
376376
377377
* `send_receiver_wallets_invitation_job`: This job is used to send disbursement invites to recipients. Its interval is configured through the `SCHEDULER_RECEIVER_INVITATION_JOB_SECONDS` environment variable.
378378
* `payment_to_submitter_job`: This job is used to submit payments from Core to the TSS. Its interval is configured through the `SCHEDULER_PAYMENT_JOB_SECONDS` environment variable.

cloudformation/eks/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ This guide walks through deploying the Stellar Disbursement Platform (SDP) infra
4141
- Creates EKS cluster and node group
4242
- Sets up IAM roles and security groups
4343
- Configures IRSA (IAM Roles for Service Accounts)
44-
- Sets up permissions for pods to access secrets stored in AWS Secrets Manager
44+
- Sets up permissions for pods to access secrets stored in AWS Secrets Manager
4545

4646
After the CloudFormation stacks are deployed, additional Kubernetes resources are installed via Helm charts to complete the setup. The SDP expects secrets to be available as Kubernetes secrets, but how those secrets are synchronized (whether through ExternalSecrets, direct creation, or other means) is left to the deployer's preference.
4747

@@ -82,7 +82,7 @@ aws cloudformation create-stack \
8282
```
8383

8484
## 3. Keys Stack Deployment
85-
For testnet, you can auto-generate Stellar secrets using the following command:
85+
For testnet, you can auto-generate Stellar secrets using the following command:
8686

8787
```bash
8888
aws cloudformation create-stack \
@@ -107,7 +107,7 @@ aws cloudformation create-stack \
107107
ParameterKey=ChannelAccountEncryptionPassphrase,ParameterValue=your-channel-encryption-passphrase \
108108
ParameterKey=DistributionAccountEncryptionPassphrase,ParameterValue=your-distribution-encryption-passphrase
109109
```
110-
for a description of these parameters, please see: [Configuring the SDP](https://developers.stellar.org/platforms/stellar-disbursement-platform/admin-guide/configuring-sdp)
110+
for a description of these parameters, please see: [Configuring the SDP](https://developers.stellar.org/docs/platforms/stellar-disbursement-platform/admin-guide/configuring-sdp)
111111

112112
## 4. EKS Cluster Deployment
113113
Deploy the EKS cluster:
@@ -374,7 +374,7 @@ aws cloudformation delete-stack --stack-name ${STACK_NAME_PREFIX}-network --regi
374374
## Additional Information
375375

376376
### Stellar Disbursement Platform Domain Structure
377-
The SDP platform uses two base-level domains for multi-tenant frontend and backend access. For example, lets say your hosted public domain is `api.example.org`. Then, you could configure a subdomain called `api.example.org` as the base-level domain for api access and `dashboard.example.org` as the front-end dashboard base-level domain. If you then added a tenant (eg `ridedash`) to the SDP, the api and dashboard URLs for them would be `ridedash.api.example.org` and `ridedash.dashboard.example.org` respectively. you can see this example in the helm-example-values file.
377+
The SDP platform uses two base-level domains for multi-tenant frontend and backend access. For example, lets say your hosted public domain is `api.example.org`. Then, you could configure a subdomain called `api.example.org` as the base-level domain for api access and `dashboard.example.org` as the front-end dashboard base-level domain. If you then added a tenant (eg `ridedash`) to the SDP, the api and dashboard URLs for them would be `ridedash.api.example.org` and `ridedash.dashboard.example.org` respectively. you can see this example in the helm-example-values file.
378378

379379
## Example Helm Values configuration
380380
The following illustrates the example configuration for backend (api) and frontend (dashboard) base domains for the public domain `example.org`. Note, these domains must have a wild-card certificate.
@@ -392,7 +392,7 @@ dashboard:
392392
393393
The following illustrates the kubernetes configurations that result from the above helm values.
394394
```bash
395-
kubectl -n sdp get ingress
395+
kubectl -n sdp get ingress
396396
NAME CLASS HOSTS ADDRESS PORTS AGE
397397
sdp ingress-public api.example.org,*.api.example.org a3ca0226bd4494ffb808a64476ddfc4f-66bf685869e3cc2e.elb.us-west-2.amazonaws.com 80, 443 9s
398398
sdp-ap ingress-public ap-api.example.org a3ca0226bd4494ffb808a64476ddfc4f-66bf685869e3cc2e.elb.us-west-2.amazonaws.com 80, 443 9s
@@ -514,4 +514,4 @@ kubectl describe pods -n sdp
514514
```bash
515515
aws secretsmanager list-secrets \
516516
--filters Key=name-prefix,Values=/sdp/${ENVIRONMENT}
517-
```
517+
```

dev/README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,15 @@
1111
- [Update local DNS](#update-local-dns)
1212
- [Set up local HTTPS (optional)](#set-up-local-https-optional)
1313
- [Automated Stellar Account Creation and .env Configuration](#automated-stellar-account-creation-and-env-configuration)
14-
- [Start/Stop Local Environment](#startstop-local-environment)
14+
- [Start Local Environment](#start-local-environment)
15+
- [Option 1: Using the Setup Wizard (Recommended)](#option-1-using-the-setup-wizard-recommended)
16+
- [Option 2: Using Docker Compose Directly](#option-2-using-docker-compose-directly)
17+
- [Option 3: Running Locally with Go (Development)](#option-3-running-locally-with-go-development)
18+
- [Mainnet Deployment](#mainnet-deployment)
19+
- [Mainnet Configuration](#mainnet-configuration)
20+
- [Mainnet Startup](#mainnet-startup)
1521
- [Login to the SDP and send a Disbursement](#login-to-the-sdp-and-send-a-disbursement)
22+
- [SEP10/SEP24 Endpoints](#sep10sep24-endpoints)
1623
- [Receive Payment to Digital Wallet (Deposit Flow)](#receive-payment-to-digital-wallet-deposit-flow)
1724
- [Additional Development Environment Details](#additional-development-environment-details)
1825
- [Stellar Accounts and .env File](#stellar-accounts-and-env-file)
@@ -25,8 +32,8 @@
2532
- [Start Prometheus and Grafana containers](#start-prometheus-and-grafana-containers)
2633
- [Load the SDP Grafana Dashboard](#load-the-sdp-grafana-dashboard)
2734
- [Troubleshooting](#troubleshooting)
28-
- [Sample Tenant Management Postman collection](#sample-tenant-management-postman-collection)
29-
- [Distribution account out of funds](#distribution-account-out-of-funds)
35+
- [Sample Tenant Management Postman collection](#sample-tenant-management-postman-collection)
36+
- [Distribution account out of funds](#distribution-account-out-of-funds)
3037

3138
## Introduction
3239

@@ -151,7 +158,7 @@ go run main.go serve \
151158

152159
You can also run the TSS by using the `tss` command instead of `serve`.
153160

154-
```sh
161+
```sh
155162
go run main.go tss \
156163
--env-file ./dev/.env.https-testnet \
157164
--database-url "postgres://postgres@localhost:5432/sdp_mtn?sslmode=disable"
@@ -212,10 +219,10 @@ make setup
212219
213220
### Login to the SDP and send a Disbursement
214221

215-
> [!NOTE]
222+
> [!NOTE]
216223
> In the following section, we will assume you're using the `bluecorp` tenant that was provisioned when you started the stack.
217224
218-
The startup prints Login information for each tenant.
225+
The startup prints Login information for each tenant.
219226
```
220227
🎉🎉🎉🎉 SUCCESS! 🎉🎉🎉🎉
221228
Login URLs for each tenant:
@@ -275,7 +282,7 @@ The SDP now provides native SEP10 and SEP24 endpoints for wallet integration:
275282
- `POST /auth` - Validate challenge and receive JWT token
276283

277284
**SEP24 Interactive Deposit Endpoints:**
278-
- `GET /sep24/info` - Get supported assets and capabilities
285+
- `GET /sep24/info` - Get supported assets and capabilities
279286
- `POST /sep24/transactions/deposit/interactive` - Initiate interactive deposit
280287
- `GET /sep24/transactions` - Get transaction status
281288

@@ -298,11 +305,11 @@ Now deposit the disbursement payment into the digital wallet using the SEP-24 de
298305
<img src="images/demo_wallet1.png" alt="Demo Wallet" width="40%">
299306

300307
6. In the `Select action` dropdown, select `SEP-24 Deposit` and then click the `Start` button.
301-
308+
302309
<img src="images/sep24_deposit1.png" alt="SEP-24 Deposit" width="40%">
303310

304311
7. In the new window, enter the phone number `+13163955627` from the disbursement CSV payment.
305-
312+
306313
<img src="images/sep24_deposit2.png" alt="Enter Phone Number" width="40%">
307314

308315
8. To verify the payment, enter the passcode and date of birth. You can use `000000` passcode or find the actual passcode in the `sdp-api` container logs.
@@ -325,7 +332,7 @@ You need to create and configure two Stellar accounts to use the SDP. You can ei
325332

326333
**Option 1: Manually Create and Configure Accounts**
327334

328-
1. Create and fund a Distribution account that will be used for sending funds to receivers. Follow the instructions [here](https://developers.stellar.org/docs/stellar-disbursement-platform/getting-started#create-and-fund-a-distribution-account).
335+
1. Create and fund a Distribution account that will be used for sending funds to receivers. Follow the instructions [here](https://developers.stellar.org/docs/platforms/stellar-disbursement-platform/getting-started#create-and-fund-a-distribution-account).
329336
2. Create a SEP-10 account for authentication. It can be created the same way as the distribution account but it doesn't need to be funded.
330337
3. Create a `.env` file in the `dev` directory by copying the [env.example](.backup/.env.example) file:
331338
```sh

helmchart/sdp/templates/NOTES.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Your release is named {{ .Release.Name }} and deployed to namespace {{ .Release.
9595
6. Create your first tenant:
9696
If you don't have a tenant yet, you'll need to create one to start using the SDP.
9797
Tenant provisioning is documented at:
98-
https://developers.stellar.org/platforms/stellar-disbursement-platform/admin-guide/tenant-provisioning
98+
https://developers.stellar.org/docs/platforms/stellar-disbursement-platform/admin-guide/tenant-provisioning
9999

100100
To calculate the auth header for the admin API, run:
101101

@@ -111,4 +111,4 @@ Your release is named {{ .Release.Name }} and deployed to namespace {{ .Release.
111111
# Use this value in your API requests as:
112112
# curl -H "Authorization: $AUTH_HEADER" ...
113113

114-
For more information and configuration options, please refer to the README.md file.
114+
For more information and configuration options, please refer to the README.md file.

0 commit comments

Comments
 (0)