Skip to content

Commit 915dba0

Browse files
Fixing the linter to take into account subfolders as well (security-alliance#191)
* Fixing the linter to take into account subfolders as well * Mass fixing linting * fixing linting in justfile * Update src/external-security-reviews/README.md Co-authored-by: Dickson Wu <33645481+DicksonWu654@users.noreply.github.com> --------- Co-authored-by: Dickson Wu <33645481+DicksonWu654@users.noreply.github.com>
1 parent d648de8 commit 915dba0

152 files changed

Lines changed: 476 additions & 344 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/md-lint.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ jobs:
1414
continue-on-error: true
1515
with:
1616
globs: |
17-
src/*.md
17+
src/**/*.md

.markdownlint.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"default": true,
3+
"MD013": {
4+
"line_length": 120,
5+
"code_blocks": false,
6+
"tables": false
7+
},
8+
"MD024": {
9+
"siblings_only": true
10+
},
11+
"MD025": false,
12+
"MD033": {
13+
"allowed_elements": ["details", "summary", "br", "img", "sup", "sub", "kbd"]
14+
},
15+
"MD041": false
16+
}

justfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ lint:
1717
@echo "Spell check complete!"
1818
@echo ""
1919
@echo "Running markdownlint..."
20-
markdownlint-cli2 ./src/*.md
20+
markdownlint-cli2 ./src/**/*.md

src/awareness/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ The modern digital landscape is filled with sophisticated attacks, including web
3737
2. [Understanding Threat Vectors](./understanding-threat-vectors.md) - Comprehensive overview of attack methods, indicators, and preventive measures
3838
3. [Cultivating a Security-Aware Mindset](./cultivating-a-security-aware-mindset.md) - Behavioral practices and organizational strategies for building a security culture
3939
4. [Staying Informed & Continuous Learning](./staying-informed-and-continuous-learning.md) - Training frameworks, educational approaches, and information sources
40-
5. [Resources & Further Reading](./resources-and-further-reading.md) - External tools, references, and resources for ongoing security education
40+
5. [Resources & Further Reading](./resources-and-further-reading.md) - External tools, references, and resources for ongoing security education

src/awareness/cultivating-a-security-aware-mindset.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ A community manager receives a direct message on Discord that looks like it come
3434

3535
## 3.2 Awareness in Community Settings
3636

37-
### Unique Challenges on Social Platforms:
37+
### Unique Challenges on Social Platforms
3838

3939
- **Platform-Specific Red Flags:**
4040
Each community platform—Discord, Twitter, Telegram—has its own quirks.
@@ -144,4 +144,4 @@ Encourage prompt reporting by focusing on solutions rather than blame.
144144
**Example:** Acknowledge and thank team members who report potential issues, even if they turn out to be false alarms.
145145

146146
> **Scenario Example**
147-
A team member notices unusual login attempts to their account. Instead of ignoring it or feeling embarrassed, they immediately report it to the security team, who can then investigate whether this is part of a larger attack pattern affecting other users.
147+
A team member notices unusual login attempts to their account. Instead of ignoring it or feeling embarrassed, they immediately report it to the security team, who can then investigate whether this is part of a larger attack pattern affecting other users.

src/awareness/resources-and-further-reading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Read detailed incident reports and analysis (available from sources like Verizon
3232

3333
**Example Resources:**
3434

35-
- Personal security checklist: [Digital Defense](https://digital-defense.io) (we are currently developing a version of this based on frameworks, will be available at https://check.frameworks.securityalliance.dev).
35+
- Personal security checklist: [Digital Defense](https://digital-defense.io) (we are currently developing a version of this based on frameworks, will be available at <https://check.frameworks.securityalliance.dev>).
3636
- Interactive phishing simulation: [Phishing Dojo](https://phishing.therektgames.com).
3737
- [SEAL's blog](https://securityalliance.org/news) on frameworks.
3838

src/awareness/understanding-threat-vectors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,4 +147,4 @@ Never sign a transaction unless you are completely sure exactly what you are sig
147147

148148
- **Hardware Wallets for Critical Assets:**
149149
Use hardware wallets for storing significant cryptocurrency holdings.
150-
**Scenario Example:** Keeping your long-term investments on a hardware wallet while only maintaining small amounts in hot wallets for daily transactions.
150+
**Scenario Example:** Keeping your long-term investments on a hardware wallet while only maintaining small amounts in hot wallets for daily transactions.

src/community-management/telegram.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ If you manage Telegram groups or channels, properly configuring admin permission
153153

154154
### Passcode Lock
155155

156-
- **Settings > Privacy and Security > Passcode Lock:** This feature adds a passcode to access your Telegram app after a period of inactivity. The default setting is "away for 1 hour."
156+
- **Settings > Privacy and Security > Passcode Lock:** This feature adds a passcode to access your Telegram app after a period of inactivity. The default setting is "away for 1 hour."
157157
- **Recommendations:**
158158
- **Store Passcode Securely:** Do not lose this passcode—store it offline if needed.
159159
- **Unique Passcode:** Ensure it is different from your phone's unlock passcode.
@@ -170,8 +170,8 @@ If you manage Telegram groups or channels, properly configuring admin permission
170170
- **Security Measures:**
171171
- **SMS Codes:** Telegram sends a code via SMS, which is not secure.
172172
- **Email Recovery:** Offers email recovery, which is more secure but lacks options for authenticator apps or hardware keys.
173-
- **Important:**
174-
- **Backup Password:** If you lose this password, access to your account may be compromised.
173+
- **Important:**
174+
- **Backup Password:** If you lose this password, access to your account may be compromised.
175175
- **Secure Storage:** Write it down offline and ensure it is not lost.
176176

177177
#### Additional Privacy Settings

src/config/template.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ contributors:
1616

1717
# {{ Title of this Page }}
1818

19-
20-
Key Takeaway prompt: Without removing or modifying anything in the document, just after the heading, describe in a succint way (no more than 40 words), all the key points or tl;dr so that anyone can get a good grasp of the contents just by reading it. Don't add unnecessary sentences that sound like conclusions, like "By ensuring this..." "Doing all these...", "Having these security practinces...". Use the following format > 🔑 **Key Takeaway**:
19+
Key Takeaway prompt: Without removing or modifying anything in the document, just after the heading, describe in a succint way (no more than 40 words), all the key points or tl;dr so that anyone can get a good grasp of the contents just by reading it. Don't add unnecessary sentences that sound like conclusions, like "By ensuring this..." "Doing all these...", "Having these security practinces...". Use the following format > 🔑 **Key Takeaway**:
2120

2221
[Context / Problem statement. In this first part, we introduce the topic, in no more than a few paragraphs. For example for Threat Modeling inside Operational Security Framework: "Effective security requires understanding **what you're protecting and who you're protecting it from**. Without a structured threat model, security efforts become unfocused and inefficient. Different entities face different threats based on their assets, visibility, and technological footprint." It can be this short, or it can have more context]
2322

src/config/using-contributors.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This page demonstrates how to use the centralized contributors database. Instead
77
### Basic Contributors List
88

99
In your markdown frontmatter, simply list the contributor IDs:
10+
1011
```markdown
1112
---
1213
title: Your Page Title
@@ -20,6 +21,7 @@ contributors:
2021
### Role-Based Contributors
2122

2223
You can also specify contributors with their roles, which will display them in organized sections:
24+
2325
```markdown
2426
---
2527
title: Your Page Title

0 commit comments

Comments
 (0)