Skip to content

Commit fd48996

Browse files
committed
docs: added CI/CD pip requirments + alt for images
1 parent 5a0078d commit fd48996

File tree

5 files changed

+6
-12
lines changed

5 files changed

+6
-12
lines changed

docs/core/logger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Logger provides an opinionated logger with output structured as JSON.
1616
<br />
1717

1818
<figure>
19-
<img src="../../media/logger_utility_showcase.png" loading="lazy" />
19+
<img src="../../media/logger_utility_showcase.png" loading="lazy" alt="Screenshot of the Amazon CloudWatch Console showing an example of error logged with various log attributes" />
2020
<figcaption>Logger showcase - Log attributes</figcaption>
2121
</figure>
2222

docs/core/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ These metrics can be visualized through [Amazon CloudWatch Console](https://cons
1717
<br />
1818

1919
<figure>
20-
<img src="../../media/metrics_utility_showcase.png" loading="lazy" />
20+
<img src="../../media/metrics_utility_showcase.png" loading="lazy" alt="Screenshot of the Amazon CloudWatch Console showing an example of business metrics in the Metrics Explorer" />
2121
<figcaption>Metrics showcase - Metrics Explorer</figcaption>
2222
</figure>
2323

docs/core/tracer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Tracer is an opinionated thin wrapper for [AWS X-Ray SDK for Node.js](https://gi
1616
<br />
1717

1818
<figure>
19-
<img src="../../media/tracer_utility_showcase.png" loading="lazy" />
19+
<img src="../../media/tracer_utility_showcase.png" loading="lazy" alt="Screenshot of the Amazon CloudWatch Console showing an example of segments and subsegments generated and with annotations set for the handler" />
2020
<figcaption>Tracer showcase - Handler Annotations</figcaption>
2121
</figure>
2222

@@ -223,7 +223,7 @@ When using the `captureLambdaHandler` decorator or middleware, Tracer performs t
223223
```
224224

225225
<figure>
226-
<img src="../../media/tracer_utility_showcase_2.png" loading="lazy"/>
226+
<img src="../../media/tracer_utility_showcase_2.png" loading="lazy" alt="Screenshot of the Amazon CloudWatch Console showing an example of segments and subsegments generated and with metadata set for the handler"/>
227227
<figcaption>Tracer showcase - Handler Metadata</figcaption>
228228
</figure>
229229

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
mike==1.1.2
22
mkdocs-material==8.3.6
33
mkdocs-git-revision-date-plugin==0.3.2
4+
mkdocs-glightbox==0.1.6

mkdocs.yml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,7 @@ copyright: Copyright &copy; 2022 Amazon Web Services
7575
plugins:
7676
- git-revision-date
7777
- search
78-
- glightbox:
79-
touchNavigation: true
80-
loop: false
81-
effect: zoom
82-
width: 100%
83-
height: auto
84-
zoomable: true
85-
draggable: true
78+
- glightbox
8679

8780
extra_css:
8881
- stylesheets/extra.css

0 commit comments

Comments
 (0)