Skip to content

Commit 627a8e6

Browse files
committed
docs(README): #356 rename the doc-resources dir to docs
1 parent d3f3cf6 commit 627a8e6

15 files changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ The three different takes the responsibilities as below:
9595
- Connector/Repository: The only responsibility of this layer is to fetch data which is required by the Service layer to perform the business logic to serve the request.<br>
9696
When our Microservice makes a call to another Service we would like to name it as Connector (as in our case) layer whereas when interacting with a DB commonly it's known as Repository.
9797

98-
![](doc-resources/images/microservice-structure.png)
98+
![](docs/images/microservice-structure.png)
9999

100100
### Development Practice
101101

@@ -105,7 +105,7 @@ While developing the code I followed BDD first approach where I wrote a failing
105105
driving our development through behavior and then followed by Test Driven Development.<br>
106106
A feature is not considered as developed until all the Unit Tests (TDD) and feature (BDD) passes.
107107

108-
![](doc-resources/images/bdd-tdd-cycle.png)
108+
![](docs/images/bdd-tdd-cycle.png)
109109

110110
## Integrations
111111

@@ -125,7 +125,7 @@ Once executed a report as below will be generated at local path
125125
build/reports/tests/test/index.html
126126
```
127127

128-
![](doc-resources/images/unit-test-report.png)
128+
![](docs/images/unit-test-report.png)
129129

130130
#### 1.2 Cucumber End-to-End Test
131131

@@ -154,7 +154,7 @@ once the test execution completes report should be accessible at:
154154
../build/reports/pitest/[TIMESTAMP]/index.html
155155
```
156156

157-
![](doc-resources/images/pitest-report.png)
157+
![](docs/images/pitest-report.png)
158158

159159
#### 1.4 Local Testing
160160

@@ -233,7 +233,7 @@ build/reports/checkstyle/main.html
233233
build/reports/checkstyle/test.html
234234
```
235235

236-
![](doc-resources/images/checkstyle-report.png)
236+
![](docs/images/checkstyle-report.png)
237237

238238
</details>
239239

@@ -313,7 +313,7 @@ Once successfully executed a report as shown below will be generated at path
313313
build/reports/jacocoHtml/index.html
314314
```
315315

316-
![](doc-resources/images/jacoco-report.png)
316+
![](docs/images/jacoco-report.png)
317317

318318
</details>
319319

@@ -385,7 +385,7 @@ To test it locally start the application then Swagger UI documentation can be ac
385385
http://localhost:8080/companieshouse/swagger-ui/index.html
386386
```
387387

388-
![](doc-resources/images/swagger-ui.png)
388+
![](docs/images/swagger-ui.png)
389389
Once application is deployed in a Platform the same documentation will be accessible by below URL:
390390

391391
```bash
@@ -398,7 +398,7 @@ where "companieshouse" is the context path.
398398

399399
DevSecOps stands for development, security, and operations. It's an approach to culture, automation, and platform design that integrates security as a shared responsibility throughout the entire application and infrastructure security lifecycle.
400400

401-
![](doc-resources/images/devsecops.png)
401+
![](docs/images/devsecops.png)
402402

403403
In this repo we are looking at some of the key practices to secure the application and infrastructure.
404404

@@ -452,7 +452,7 @@ In this section we are focusing on identifying [vulnerabilities](https://owasp.o
452452
build/reports/dependency-vulnerabilities
453453
```
454454
455-
![](doc-resources/images/dependency-check-report.png)
455+
![](docs/images/dependency-check-report.png)
456456
457457
Suppression:<br>
458458
If you wish to suppress dependencies from vulnerability analysis (maybe because of breaking changes) declare them in the [dependency-check-suppression.xml](config/dependencycheck/dependency-check-suppression.xml) as below:
@@ -633,7 +633,7 @@ Continuous Integration is a key step to digital transformation.
633633
To do Continuous Deployment you must be doing Continuous Delivery.
634634
635635
Pictorial representation of the above two approaches:
636-
![](doc-resources/images/continuous-delivery-deployment.png)
636+
![](docs/images/continuous-delivery-deployment.png)
637637
638638
Reference :
639639
@@ -719,7 +719,7 @@ This Dockerfile will be handy and is an example of using intermediate containers
719719
```
720720
Output:
721721
722-
![](doc-resources/images/docker-images.png)
722+
![](docs/images/docker-images.png)
723723
724724
- To start the container using the newly created docker image
725725
```bash
@@ -747,7 +747,7 @@ This Dockerfile will be handy and is an example of using intermediate containers
747747
```
748748
749749
Output:
750-
![](doc-resources/images/docker-container.png)
750+
![](docs/images/docker-container.png)
751751
752752
Take note of the CONTAINER ID.
753753
@@ -880,7 +880,7 @@ Further Reading:
880880
- [Executors](): Underlying technology or environment in which to run a job. Example: Docker images, Linux virtual machine (VM) image, macOS VM image, Windows VM image
881881
- [Orbs](https://circleci.com/docs/2.0/jobs-steps/#orbs-overview): Reusable & Shareable packages of configs which can be imported to ease the pipeline configurable.
882882
4. Click [here](.circleci/config.yml) to open the CircleCI config file for this project. When this config runs for the "workflow-all-jobs" the output pipeline is shown below and deploys the app to AWS EKS Cluster.
883-
![](doc-resources/images/circleci-pipeline.png)
883+
![](docs/images/circleci-pipeline.png)
884884
5. If you wish to use this config file in your project you must create a context "credentials" and add below Environment Variables with respective values.
885885
886886
Follow [link](https://circleci.com/docs/2.0/env-vars/?utm_medium=SEM&utm_source=gnb&utm_campaign=SEM-gb-DSA-Eng-ni&utm_content=&utm_term=dynamicSearch-&gclid=EAIaIQobChMIm_2blLze6QIVQeztCh3FGwh0EAAYASAAEgITlPD_BwE#setting-an-environment-variable-in-a-context) to learn how to do it.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)