Skip to content

Commit e0c28a5

Browse files
renovate[bot]jburns24
renovate[bot]
and
jburns24
authored
chore(deps): update davidanson/markdownlint-cli2-action action to v21 (#786)
* chore(deps): update davidanson/markdownlint-cli2-action action to v21 * chore: fix markdown violations and also updated local markdownlint cli version --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Joshua Burns <joshua.burns@liatrio.com>
1 parent 2470a94 commit e0c28a5

File tree

12 files changed

+85
-97
lines changed

12 files changed

+85
-97
lines changed

‎.github/workflows/markdown-linter.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
if: github.event.pull_request.draft == false
1212
steps:
1313
- uses: actions/checkout@v6
14-
- uses: DavidAnson/markdownlint-cli2-action@v20
14+
- uses: DavidAnson/markdownlint-cli2-action@v21
1515
with:
1616
globs: |
1717
*.md

‎docs/1-introduction/1.3.1-unix.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ rm -r liatrio_console_tutorial
168168
| `ls` | `ls` | Prints the contents of the current directory |
169169
| `find` | `find . -name "myfile"` | Prints the location of a resource |
170170
| `cat` | `cat my_file` | Prints the contents of a specified file |
171-
| `echo` | `echo 'Hello'` | Prints the given arguments to the console |
171+
| `echo` | `echo 'Hello'` | Prints the given arguments to the console |
172172
| `which` | `which java` | Prints the path to the specified executable |
173173
| `man` | `man pwd` | Displays the manual pages for the specified arguments |
174174
| `rm` | `rm my_file` | Permanently deletes a resource |

‎docs/1-introduction/1.3.2-vim.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -96,13 +96,13 @@ and replacing.
9696
Command mode lets you send commands to Vim that you wouldn't be able to do with
9797
Normal mode.
9898

99-
| Command | Description |
100-
| ---- | ----------- |
101-
| `:` | Insert Command Mode |
102-
| `w` | Save the file |
103-
| `q` | Quit Vim |
104-
| `q!`| Quit without saving |
105-
| `wq`| Save and quit from Vim |
99+
| Command | Description |
100+
| ---- | ----------- |
101+
| `:` | Insert Command Mode |
102+
| `w` | Save the file |
103+
| `q` | Quit Vim |
104+
| `q!` | Quit without saving |
105+
| `wq` | Save and quit from Vim |
106106

107107
## Exercise
108108

‎docs/3-AI-Engineering/3.3.2-agentic-ide.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ As of the time of writing each of these are all very close in feature sets thoug
4646

4747
While the features of agentic IDEs can vary, there are some common features that are typically available. These include rule/instruction files, workflows, and MCP servers (which were covered previously). All major agentic IDEs have native support for MCP servers.
4848

49-
| Feature | Description | Key Capabilities |
50-
|---------|-------------|------------------|
51-
| **Intelligent Code Completion** | Advanced code suggestions that understand context | • Context-aware suggestions<br>• Whole-line and multi-line completions<br>• API and documentation integration |
52-
| **Automated Refactoring** | Tools to improve and modernize code | • Code quality improvements<br>• Pattern recognition and application<br>• Technical debt identification |
53-
| **Natural Language Interfaces** | Conversational AI assistance for development tasks | • Conversational coding assistance<br>• Documentation generation<br>• Bug explanation and fixes |
54-
| **Contextual Understanding** | Deep awareness of codebase structure and relationships | • Codebase awareness<br>• Dependency analysis<br>• Architectural insights |
49+
| Feature | Description | Key Capabilities |
50+
|---------------------------------|--------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
51+
| **Intelligent Code Completion** | Advanced code suggestions that understand context | • Context-aware suggestions<br>• Whole-line and multi-line completions<br>• API and documentation integration |
52+
| **Automated Refactoring** | Tools to improve and modernize code | • Code quality improvements<br>• Pattern recognition and application<br>• Technical debt identification |
53+
| **Natural Language Interfaces** | Conversational AI assistance for development tasks | • Conversational coding assistance<br>• Documentation generation<br>• Bug explanation and fixes |
54+
| **Contextual Understanding** | Deep awareness of codebase structure and relationships | • Codebase awareness<br>• Dependency analysis<br>• Architectural insights |
5555

5656
### Rule/Instruction Files
5757

@@ -152,7 +152,7 @@ prompt: |
152152
Write a comprehensive unit test for the following function.
153153
Focus on edge cases and error conditions.
154154
Use the testing framework from the existing test files.
155-
155+
156156
Function to test:
157157
{{selected_code}}
158158
```

‎docs/6-software-development-practices/6.1.1-scrum.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ Establishing a base for the team's ceremonies helps create a rhythm and cadence.
5454

5555
![A calendar showing one team's Scrum meeting frequency: standup is daily, refinement twice a week, and planning and retrospective are once every two weeks](img6/agile-ceremonies.webp)
5656

57-
| Ceremony | Purpose | Duration | Audience |
58-
| -- | -- | -- | -- |
59-
| **Refinement** | Refine backlog stories, update with outstanding questions and point stories that are fully refined. | 1hr | Everyone |
60-
| **Sprint Planning** | Confirm backlog stories are fully defined and pointed and decide which stories to pull into the upcoming sprint. | 30min | Everyone |
61-
| **Stand up** | Daily team touch point. Walk the board or discuss work accomplished yesterday, work planned for today, and blockers | 15 min | Everyone |
62-
| **Demo & Retro** | Demonstrate code changes to the team, product owner, and stakeholders. Discuss what went well and what improvements can be made. | 1hr | Everyone |
57+
| Ceremony | Purpose | Duration | Audience |
58+
| -- | -- | -- | -- |
59+
| **Refinement** | Refine backlog stories, update with outstanding questions and point stories that are fully refined. | 1hr | Everyone |
60+
| **Sprint Planning** | Confirm backlog stories are fully defined and pointed and decide which stories to pull into the upcoming sprint. | 30min | Everyone |
61+
| **Stand up** | Daily team touch point. Walk the board or discuss work accomplished yesterday, work planned for today, and blockers | 15 min | Everyone |
62+
| **Demo & Retro** | Demonstrate code changes to the team, product owner, and stakeholders. Discuss what went well and what improvements can be made. | 1hr | Everyone |
6363

6464
3 Amigos, part of BDD practice, include 30 minute sessions with relevant team members to surface questions and assumptions around product, development, and testing. Although some teams decide to incorporate this into a regularly cadenced ceremony, other teams follow the recommendation to have them adhoc.
6565

‎docs/6-software-development-practices/6.2-jira.md‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -45,43 +45,43 @@ Jira refers to tickets as *issues.* Although there are various ticket types out
4545

4646
# Epic Recommended Fields
4747

48-
| Issue Type | Recommended Field | Purpose |
49-
| --- | --- | --- |
50-
| **Epic** | Project | Pick the relevant project (one team can work on multiple projects) |
51-
| **Epic** | Summary | High level description of Epic |
52-
| **Epic** | Assignee | Individual initially accountable for Epic’s completion |
53-
| **Epic** | Labels | Can be used to specify the team and other activities tags |
54-
| **Epic** | Description | Detailed information about the Epic |
55-
| **Epic** | Attachment | Attach files or documents that are relevant to the Epic |
56-
| **Epic** | Fix Version/s| Version and Release this Epic is planned for |
48+
| Issue Type | Recommended Field | Purpose |
49+
| --- | --- | --- |
50+
| **Epic** | Project | Pick the relevant project (one team can work on multiple projects) |
51+
| **Epic** | Summary | High level description of Epic |
52+
| **Epic** | Assignee | Individual initially accountable for Epic’s completion |
53+
| **Epic** | Labels | Can be used to specify the team and other activities tags |
54+
| **Epic** | Description | Detailed information about the Epic |
55+
| **Epic** | Attachment | Attach files or documents that are relevant to the Epic |
56+
| **Epic** | Fix Version/s | Version and Release this Epic is planned for |
5757

5858
# Story Recommended Fields
5959

60-
| Issue Type | Recommended Field | Purpose |
61-
| --- | --- | --- |
62-
| **Story** | Summary | High level description of Story|
63-
| **Story** | Assignee | Individual initially accountable for Story completion |
64-
| **Story**| Labels | Can be used to specify the team and other activities tags |
65-
| **Story**| Flag | Is this work currently blocked by another issue? |
66-
| **Story** | Description | Detailed information about the Story |
67-
| **Story** | Story Points | Relative Scale: 1, 2, 3, 5, 8, 13, 21 |
68-
| **Story**| Sprint | Anticipated Sprint this user Story will be completed in |
69-
| **Story**| Linked Issues | Stories that must be completed prior, concurrent or after this story|
70-
| **Story**| Attachment | Attach files or documents that are relevant to the Story|
71-
| **Story** | Fix Version/s| Version and Release this Story is planned for |
60+
| Issue Type | Recommended Field | Purpose |
61+
| --- | --- | --- |
62+
| **Story** | Summary | High level description of Story |
63+
| **Story** | Assignee | Individual initially accountable for Story completion |
64+
| **Story** | Labels | Can be used to specify the team and other activities tags |
65+
| **Story** | Flag | Is this work currently blocked by another issue? |
66+
| **Story** | Description | Detailed information about the Story |
67+
| **Story** | Story Points | Relative Scale: 1, 2, 3, 5, 8, 13, 21 |
68+
| **Story** | Sprint | Anticipated Sprint this user Story will be completed in |
69+
| **Story** | Linked Issues | Stories that must be completed prior, concurrent or after this story|
70+
| **Story** | Attachment | Attach files or documents that are relevant to the Story. |
71+
| **Story** | Fix Version/s | Version and Release this Story is planned for |
7272

7373
# Subtask Recommended Fields
7474

75-
| Issue Type | Recommended Field | Purpose |
76-
| --- | --- | --- |
77-
| **Subtask** | Summary | High level description of Task or Subtask|
78-
| **Subtask** | Assignee | Individual initially accountable for Task or Subtask completion |
79-
| **Subtask** | Flag | Is this work currently blocked by another issue? |
80-
| **Subtask** | Description | Detailed information about the Story |
81-
| **Subtask** | Sprint | Anticipated Sprint this user Story will be completed in |
82-
| **Subtask** | Linked Issues | Tasks or Subtasks that must be completed prior, concurrent or after this story|
83-
| **Subtask** | Attachment | Attach files or documents that are relevant to the Story|
84-
| **Subtask** | Fix Version/s| Version and Release this Task is planned for |
75+
| Issue Type | Recommended Field | Purpose |
76+
| --- | --- | --- |
77+
| **Subtask** | Summary | High level description of Task or Subtask |
78+
| **Subtask** | Assignee | Individual initially accountable for Task or Subtask completion |
79+
| **Subtask** | Flag | Is this work currently blocked by another issue? |
80+
| **Subtask** | Description | Detailed information about the Story |
81+
| **Subtask** | Sprint | Anticipated Sprint this user Story will be completed in |
82+
| **Subtask** | Linked Issues | Tasks or Subtasks that must be completed prior, concurrent or after this story|
83+
| **Subtask** | Attachment | Attach files or documents that are relevant to the Story |
84+
| **Subtask** | Fix Version/s | Version and Release this Task is planned for |
8585

8686
## Creating Effective Jira Tickets
8787

‎docs/6-software-development-practices/6.3.2-git.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,17 +69,17 @@ Although Git can watch everything in your working directory, not everything on y
6969
|----------------|----------------------------------------------------------------------------------------------------------------|
7070
| `git init` | Initializes a new local Git repository |
7171
| `git clone` | Creates a local Git repository copied from a remote |
72-
| `git add` | Stages local changes to be committed |
72+
| `git add` | Stages local changes to be committed |
7373
| `git commit` | Commits staged changes into Git history |
74-
| `git fetch` | Synchronizes information about a remote repository |
74+
| `git fetch` | Synchronizes information about a remote repository |
7575
| `git push` | Pushes local commits to a remote repository |
76-
| `git pull` | Pulls commits from a remote repository and merges them with a local copy |
77-
| `git branch` | Provides information about different branches |
76+
| `git pull` | Pulls commits from a remote repository and merges them with a local copy |
77+
| `git branch` | Provides information about different branches |
7878
| `git checkout` | Changes the state of HEAD to a different branch or commit |
7979
| `git status` | Displays current information about the state of your Git repository |
8080
| `git log` | Displays Git's commit history |
8181
| `git reset` | Resets Git history to the state of a previous commit, permanently changing history |
82-
| `git rebase` | Appends a Git branch onto another branch or commit, permanently changing history |
82+
| `git rebase` | Appends a Git branch onto another branch or commit, permanently changing history |
8383

8484
# The Basics
8585

‎docs/9-kubernetes-container-orchestration/9.3-probes.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ Probes provide a uniform interface to manage the health of workloads in a Kubern
4949
### Shared Configurable Fields
5050

5151
| Field | Description | Default (sec) |
52-
|---------------------|---------------------------------------------------------------------------------------|--------------|
53-
| initialDelaySeconds | Time till the probe starts running after container startup. | 0 |
54-
| periodSeconds | How long the probe will run. | 10 |
55-
| timeoutSeconds | Probe timeout. | 1 |
56-
| successThreshold | The number of successful probes necessary for a container to be marked healthy/ready. | 1 |
57-
| failureThreshold | How many times a probe will try before deeming unhealthy/not ready. | 3 |
52+
|---------------------|---------------------------------------------------------------------------------------|-------------- |
53+
| initialDelaySeconds | Time till the probe starts running after container startup. | 0 |
54+
| periodSeconds | How long the probe will run. | 10 |
55+
| timeoutSeconds | Probe timeout. | 1 |
56+
| successThreshold | The number of successful probes necessary for a container to be marked healthy/ready. | 1 |
57+
| failureThreshold | How many times a probe will try before deeming unhealthy/not ready. | 3 |
5858

5959
### Setup
6060

‎docs/9-kubernetes-container-orchestration/9.4-rbac.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ API Objects for configuring RBAC: Role, ClusterRole, RoleBinding, and ClusterRol
3232
| Authorization Mode | Description |
3333
|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
3434
| RBAC | (Role-based Access Control) is a method of regulating access to computer or network resources based on the roles of individual users within an enterprise. |
35-
| Node | Grants permissions to kubelets based on the pods they're scheduled to run. |
35+
| Node | Grants permissions to kubelets based on the pods they're scheduled to run. |
3636
| ABAC | (Attribute-Based Access Control) grants rights to users based on policies that combine attributes together. |
3737
| Webhook | Is an HTTP callback; a simple event-notification via HTTP POST. |
3838

0 commit comments

Comments
 (0)