Skip to content

Commit 7805a37

Browse files
committed
Formating md
1 parent f2e3ec2 commit 7805a37

3 files changed

Lines changed: 9 additions & 6 deletions

File tree

getting-started/docker-compose/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,18 +236,22 @@ You can quickly use the Zaken API by creating a sample case ("zaak") using Postm
236236
**Steps:**
237237
238238
1. **Import the Create Case collection and environment**
239+
239240
- Open Postman;
240241
- Go to the Collections tab. Import [ZGW Create Case.postman_collection.json](https://github.com/OneGround/ZGW-APIs-postman-tests/blob/main/ZGW%20Create%20Case.postman_collection.json);
241242
- Go to the Environments tab. Import [ZGW Create Case.environment.json](https://github.com/OneGround/ZGW-APIs-postman-tests/blob/main/ZGW%20Create%20Case.environment.json).
242243
243244
2. **Obtain an Access Token**
245+
244246
- Follow the instructions in the "Configure API Authentication" section above to get a valid access token.
245247
- Paste the token into the `jwt_token` variable in your Postman Create Case Environment.
246248
247249
3. **Set Up Other Environment Variables**
250+
248251
- Update the variables for your local setup if they deviate from standard set up, such as `zrc_url`.
249252
250253
4. **Create a Sample Case**
254+
251255
- In the imported collection `ZGW Create Case`, find the folder named `Casetype`. Click 'run' and 'Run ZGW Create Case'. The catalog will be created, a case and other types will be added.
252256
- Find the folder named `Case`. Click 'run' and 'Run ZGW Create Case'. The case with related entities (status, result, document) will be added. If you need more cases run it multiple times.
253257
@@ -259,7 +263,6 @@ To stop all running Docker containers, run the following command from the `docke
259263
260264
```bash
261265
docker compose down
262-
263266
```
264267
265268
## Service Endpoints and Tools

getting-started/standalone/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Before you begin, ensure you have the following components installed and running
4141
- A running **PostgreSQL** instance
4242
- A running **Redis** instance
4343
- An **OAuth2** compliant Identity Provider
44-
- A running **RabbitMQ** instance (_only required for the Notificaties API or if using the event bus for notifications_)
44+
- A running **RabbitMQ** instance (*only required for the Notificaties API or if using the event bus for notifications*)
4545

4646
> **Note:** Not all APIs require every component. See the [API-Specific Configuration](#api-specific-configuration) section for the exact prerequisites for each service.
4747
@@ -438,8 +438,6 @@ Logging__LogLevel__Default=Warning
438438

439439
---
440440

441-
---
442-
443441
## License
444442

445443
This project is licensed under the [**BSD 3-Clause License**](https://github.com/OneGround/ZGW-APIs/blob/main/LICENSE).

localdev/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ Follow the steps for your operating system.
8282
#### For Windows (using PowerShell)
8383

8484
1. **Open PowerShell as an Administrator.**
85+
8586
- Click the Start menu, type "PowerShell", right-click on "Windows PowerShell", and select "Run as administrator".
8687

8788
2. **Navigate to the certificate installer directory:**
@@ -108,7 +109,7 @@ Follow the steps for your operating system.
108109
.\install-oneground-certificate.ps1 -RelativeCertPath "..\..\localdev\oneground-certificates\oneground.local.pem"
109110
```
110111
111-
The script will import the certificate into the Windows "Trusted Root Certification Authorities" store.
112+
The script will import the certificate into the Windows "Trusted Root Certification Authorities" store.
112113
113114
#### For macOS and Linux (using Bash)
114115
@@ -131,7 +132,7 @@ The script will import the certificate into the Windows "Trusted Root Certificat
131132
./install-oneground-certificate.sh ../../oneground-certificates/oneground.local.pem
132133
```
133134
134-
This script installs the certificate into your system's keychain or trust store.
135+
This script installs the certificate into your system's keychain or trust store.
135136
136137
> **Note:** After installing the certificate, we recommend restarting your web browser to ensure the changes take effect.
137138
@@ -140,6 +141,7 @@ This script installs the certificate into your system's keychain or trust store.
140141
To ensure all services can communicate with each other and are accessible in your browser, you need to map the service hostnames to your local machine. This is a crucial step for the local domain names (e.g., `zaken.oneground.local`) to work correctly.
141142
142143
1. Open your `hosts` file as an administrator.
144+
143145
- **Windows:** `C:\Windows\System32\drivers\etc\hosts`
144146
- **macOS/Linux:** `/etc/hosts`
145147

0 commit comments

Comments
 (0)