Skip to content

Commit d60b019

Browse files
committed
chore: restructure sidebar and remove outdated documentation topics from Docusaurus project
1 parent 21bcedd commit d60b019

File tree

12 files changed

+37
-18
lines changed

12 files changed

+37
-18
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Career Development Communities
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/topics/6-observability.md renamed to docs/observability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ For example, a trace for an online food order might look like this:
6262
- **Span D: Order service creates the order (child of Span B).**
6363
- **Span E: Database query to save the order (child of Span D).**
6464

65-
If the order process is slow, the trace will visually show which span took the most time, immediately telling you whether to investigate the mobile app's UI thread, a specific microservice, or the database.
65+
If the order process is slow, the trace will visually show which span took the most time, immediately telling you whether to investigate the mobile app's UI thread, a specific micro-service, or the database.
6666

6767
### Instrumentation
6868

@@ -79,7 +79,7 @@ OpenTelemetry (OTel) has become the industry standard for instrumentation. It's
7979

8080
Observability isn’t just about having dashboards; it’s about taking action when something goes wrong. **Alerting** is the process of automatically notifying the team when a metric crosses a critical threshold. This isn't just for the backend. An alert could be "CPU utilization is above 90%" or "Crash-free user rate for the new iOS version has dropped below 99.5%."
8181

82-
When an alert fires, it triggers an **incident**. As a developer, you will likely be part of the response team, especially if the issue is related to a service or application you own—be it a microservice, a mobile app, or a web front-end.
82+
When an alert fires, it triggers an **incident**. As a developer, you will likely be part of the response team, especially if the issue is related to a service or application you own—be it a micro-service, a mobile app, or a web front-end.
8383

8484
The goal of incident response is to restore service as quickly as possible. Afterward, the team conducts a "blameless retrospective" to understand the root cause and prevent the issue from recurring. Your insights, informed by data from across the full stack, are invaluable in this process.
8585

docs/open-source.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
# Open Source

docs/topics/3-testing.md renamed to docs/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ As a developer, you are expected to:
3434

3535
### Integration Tests
3636

37-
The code you write doesn't operate in isolation—it interacts with databases, caches, APIs, and other services. **Integration tests** make sure these interactions behave correctly and as expected. An integration test checks how multiple parts of your system work together. For example, does your API endpoint fetch data from the database and return it properly? Does your service call another microservice and handle its response as intended?
37+
The code you write doesn't operate in isolation—it interacts with databases, caches, APIs, and other services. **Integration tests** make sure these interactions behave correctly and as expected. An integration test checks how multiple parts of your system work together. For example, does your API endpoint fetch data from the database and return it properly? Does your service call another micro-service and handle its response as intended?
3838

3939
As a developer, you are expected to:
4040

docs/topics/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)