From 14e8f61e8e037cdbbe23cdf0fe799d58b6f60e4e Mon Sep 17 00:00:00 2001 From: rasamhossain Date: Sun, 19 Oct 2025 21:20:00 -0400 Subject: [PATCH 1/7] Docs formatting checks using markdown linting --- .../.markdownlint/.markdownlint-cli2.yaml | 39 ++++++++++++-- .../rules/bold-with-parentheses.js | 44 +++++++++++++++ .../.markdownlint/rules/no-four-asterisks.js | 54 +++++++++++++++++++ .../rules/no-fullwidth-asterisks.js | 34 ++++++++++++ 4 files changed, 166 insertions(+), 5 deletions(-) create mode 100644 doc-locale/.markdownlint/rules/bold-with-parentheses.js create mode 100644 doc-locale/.markdownlint/rules/no-four-asterisks.js create mode 100644 doc-locale/.markdownlint/rules/no-fullwidth-asterisks.js diff --git a/doc-locale/.markdownlint/.markdownlint-cli2.yaml b/doc-locale/.markdownlint/.markdownlint-cli2.yaml index 648d4665752a5e..fffe5c14d72b1a 100644 --- a/doc-locale/.markdownlint/.markdownlint-cli2.yaml +++ b/doc-locale/.markdownlint/.markdownlint-cli2.yaml @@ -1,15 +1,20 @@ --- -# Base Markdownlint configuration +# Base Markdownlint configuration for Japanese documentation # Extended Markdownlint configuration in doc/.markdownlint/ # See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md for explanations of each rule + +customRules: + - rules/no-four-asterisks.js + - rules/no-fullwidth-asterisks.js + - rules/bold-with-parentheses.js + config: # First, set the default default: true - - # Per-rule settings in alphabetical order + + # Standard Rules code-block-style: # MD046 style: "fenced" - emphasis-style: false # MD049 header-style: # MD003 style: "atx" hr-style: # MD035 @@ -27,4 +32,28 @@ config: reference-links-images: false # MD052 ul-style: # MD004 style: "dash" - link-fragments: false # MD051 - English anchor links in translated text fail + link-fragments: false # MD051 - English anchor links in translated text fail + + # MD037: No spaces inside emphasis markers + # Covers: ** text **, __ text __, * text *, _ text _ + no-space-in-emphasis: # MD037 + severity: "warning" + + # MD049: Emphasis style consistency + emphasis-style: # MD049 + style: "consistent" # Allow both * and _ but be consistent + + # MD050: Strong style consistency + strong-style: # MD050 + style: "consistent" # Allow both ** and __ but be consistent + + # ja-JP custom rules + MD-JA001: # Four consecutive asterisks (****) + severity: "warning" + + MD-JA002: # Fullwidth asterisks (＊ should be *) + severity: "warning" + + MD-JA003: # Bold with parentheses **text(unit)** + severity: "warning" + diff --git a/doc-locale/.markdownlint/rules/bold-with-parentheses.js b/doc-locale/.markdownlint/rules/bold-with-parentheses.js new file mode 100644 index 00000000000000..e856d20d839695 --- /dev/null +++ b/doc-locale/.markdownlint/rules/bold-with-parentheses.js @@ -0,0 +1,44 @@ +// MD-JA003: Detect bold text containing parentheses +// Pattern like **text(unit)** breaks markdown rendering in some contexts + +module.exports = { + names: ["MD-JA003", "bold-with-parentheses"], + description: "Bold text should not contain parentheses", + tags: ["formatting", "emphasis"], + + function: function rule(params, onError) { + const lines = params.lines; + + lines.forEach((line, lineIndex) => { + // Pattern: **text(...)** or **text（...）** + // Matches both halfwidth () and fullwidth （）parentheses + const boldParenPattern = /\*\*[^*]*[（(][^）)]*[）)][^*]*\*\*/g; + let match; + + while ((match = boldParenPattern.exec(line)) !== null) { + const matchedText = match[0]; + + // Exclude markdown links: **[text](url)** + if (/\*\*\[[^\]]+\]\([^)]+\)\*\*/.test(matchedText)) { + continue; + } + + // Exclude if it looks like inline code with backticks + if (matchedText.includes('`')) { + continue; + } + + const column = match.index + 1; + + onError({ + lineNumber: lineIndex + 1, + detail: "Bold contains parentheses - may break markdown rendering", + context: line.trim(), + range: [column, matchedText.length], + // No auto-fix - requires manual review of context + fixInfo: null + }); + } + }); + } +}; diff --git a/doc-locale/.markdownlint/rules/no-four-asterisks.js b/doc-locale/.markdownlint/rules/no-four-asterisks.js new file mode 100644 index 00000000000000..67142f62697094 --- /dev/null +++ b/doc-locale/.markdownlint/rules/no-four-asterisks.js @@ -0,0 +1,54 @@ +// MD-JA001: Detects four consecutive asterisks (****) +// Pattern like ****text(unit)**** + +module.exports = { + names: ["MD-JA001", "no-four-asterisks"], + description: "Four consecutive asterisks (****) - likely a formatting error", + tags: ["formatting", "emphasis"], + function: function rule(params, onError) { + const lines = params.lines; + + lines.forEach((line, lineIndex) => { + // Find all occurrences of four or more asterisks + const fourAsteriskPattern = /\*{4,}/g; + let match; + + while ((match = fourAsteriskPattern.exec(line)) !== null) { + const asteriskCount = match[0].length; + const column = match.index + 1; // 1-indexed column + + // Determine the most likely fix based on context + let fixInfo = null; + let detail = ""; + + if (asteriskCount === 4) { + // Check if it's likely meant to be closing and opening bold + const before = line.substring(0, match.index); + const after = line.substring(match.index + 4); + + // If there's content before and after, suggest adding space + if (before.match(/[^\s*]$/) && after.match(/^[^\s*]/)) { + fixInfo = { + editColumn: column, + deleteCount: 4, + insertText: "** **" + }; + detail = "Should have space between closing and opening bold markers"; + } else { + detail = "Should be ** to close/open bold sections properly"; + } + } else { + detail = `Found ${asteriskCount} consecutive asterisks - check formatting`; + } + + onError({ + lineNumber: lineIndex + 1, + detail: detail, + context: line.trim(), + range: [column, asteriskCount], + fixInfo: fixInfo + }); + } + }); + } +}; diff --git a/doc-locale/.markdownlint/rules/no-fullwidth-asterisks.js b/doc-locale/.markdownlint/rules/no-fullwidth-asterisks.js new file mode 100644 index 00000000000000..868812b55f7387 --- /dev/null +++ b/doc-locale/.markdownlint/rules/no-fullwidth-asterisks.js @@ -0,0 +1,34 @@ +// MD-JA002: Detect fullwidth asterisks and suggest halfwidth replacement +// Japanese input methods sometimes produce fullwidth ＊ instead of * + +module.exports = { + names: ["MD-JA002", "no-fullwidth-asterisks"], + description: "Fullwidth asterisks (＊) should be halfwidth (*)", + tags: ["formatting", "ja-JP", "emphasis"], + + function: function rule(params, onError) { + const lines = params.lines; + + lines.forEach((line, lineIndex) => { + // Find all occurrences of fullwidth asterisk (＊) + const fullwidthPattern = /＊/g; + let match; + + while ((match = fullwidthPattern.exec(line)) !== null) { + const column = match.index + 1; // 1-indexed column + + onError({ + lineNumber: lineIndex + 1, + detail: "Fullwidth asterisk (＊) should be halfwidth (*)", + context: line.trim(), + range: [column, 1], + fixInfo: { + editColumn: column, + deleteCount: 1, + insertText: "*" + } + }); + } + }); + } +}; -- GitLab From 4e30cd53471fa9f93b9080ab7b0974d76aa07981 Mon Sep 17 00:00:00 2001 From: rasamhossain Date: Mon, 20 Oct 2025 17:55:39 -0400 Subject: [PATCH 2/7] Updated JA003 --- .../rules/bold-with-parentheses.js | 73 +++++++++++-------- 1 file changed, 44 insertions(+), 29 deletions(-) diff --git a/doc-locale/.markdownlint/rules/bold-with-parentheses.js b/doc-locale/.markdownlint/rules/bold-with-parentheses.js index e856d20d839695..dd540466515674 100644 --- a/doc-locale/.markdownlint/rules/bold-with-parentheses.js +++ b/doc-locale/.markdownlint/rules/bold-with-parentheses.js @@ -1,44 +1,59 @@ // MD-JA003: Detect bold text containing parentheses -// Pattern like **text(unit)** breaks markdown rendering in some contexts +// Pattern like **text (unit)**, **text(unit )**, **text( unit)** breaks markdown rendering in some contexts +// Doesn't catch false positives when parentheses are between bold sections without spaces module.exports = { - names: ["MD-JA003", "bold-with-parentheses"], - description: "Bold text should not contain parentheses", + names: ["MD-JA003", "bold-with-bad-spacing"], + description: "Bold with parentheses has incorrect spacing", tags: ["formatting", "emphasis"], function: function rule(params, onError) { const lines = params.lines; lines.forEach((line, lineIndex) => { - // Pattern: **text(...)** or **text（...）** - // Matches both halfwidth () and fullwidth （）parentheses - const boldParenPattern = /\*\*[^*]*[（(][^）)]*[）)][^*]*\*\*/g; - let match; - - while ((match = boldParenPattern.exec(line)) !== null) { - const matchedText = match[0]; + const boldSections = line.match(/\*\*[^*]+\*\*/g); + + if (!boldSections) return; + + boldSections.forEach(boldSection => { + const content = boldSection.slice(2, -2); - // Exclude markdown links: **[text](url)** - if (/\*\*\[[^\]]+\]\([^)]+\)\*\*/.test(matchedText)) { - continue; - } + // Only check if it has parentheses + if (!/[（(]/.test(content)) return; + + // Exclude markdown links + if (/\[[^\]]+\]\([^)]+\)/.test(content)) return; + + // Exclude inline code + if (content.includes('`')) return; - // Exclude if it looks like inline code with backticks - if (matchedText.includes('`')) { - continue; + // Check for BAD spacing patterns only: + const hasBadSpacing = + /\s{2,}[（(]/.test(content) || // 2+ spaces before ( + /[（(]\s/.test(content) || // Space after ( + /\s[）)]/.test(content); // Space before ) + + if (hasBadSpacing) { + const column = line.indexOf(boldSection) + 1; + + let detail = "Bold has incorrect spacing around parentheses"; + if (/\s{2,}[（(]/.test(content)) { + detail = "Multiple spaces before opening parenthesis"; + } else if (/[（(]\s/.test(content)) { + detail = "Space after opening parenthesis - should be removed"; + } else if (/\s[）)]/.test(content)) { + detail = "Space before closing parenthesis - should be removed"; + } + + onError({ + lineNumber: lineIndex + 1, + detail: detail, + context: line.trim(), + range: [column, boldSection.length], + fixInfo: null + }); } - - const column = match.index + 1; - - onError({ - lineNumber: lineIndex + 1, - detail: "Bold contains parentheses - may break markdown rendering", - context: line.trim(), - range: [column, matchedText.length], - // No auto-fix - requires manual review of context - fixInfo: null - }); - } + }); }); } }; -- GitLab From db61f5a13ccdd4f24612cc47958446356b4e6f8a Mon Sep 17 00:00:00 2001 From: rasamhossain Date: Wed, 22 Oct 2025 15:38:36 -0400 Subject: [PATCH 3/7] Added code ignores --- .../.markdownlint/.markdownlint-cli2.yaml | 21 ++----- ...arentheses.js => bold-with-bad-spacing.js} | 31 ++++++++-- .../.markdownlint/rules/no-four-asterisks.js | 58 +++++++++++++++++-- .../rules/no-fullwidth-asterisks.js | 50 ++++++++++++++-- 4 files changed, 130 insertions(+), 30 deletions(-) rename doc-locale/.markdownlint/rules/{bold-with-parentheses.js => bold-with-bad-spacing.js} (72%) diff --git a/doc-locale/.markdownlint/.markdownlint-cli2.yaml b/doc-locale/.markdownlint/.markdownlint-cli2.yaml index fffe5c14d72b1a..e691161774aa11 100644 --- a/doc-locale/.markdownlint/.markdownlint-cli2.yaml +++ b/doc-locale/.markdownlint/.markdownlint-cli2.yaml @@ -6,15 +6,15 @@ customRules: - rules/no-four-asterisks.js - rules/no-fullwidth-asterisks.js - - rules/bold-with-parentheses.js + - rules/bold-with-bad-spacing.js config: # First, set the default default: true - # Standard Rules code-block-style: # MD046 style: "fenced" + emphasis-style: false # MD049 - KEEP DISABLED (original setting) header-style: # MD003 style: "atx" hr-style: # MD035 @@ -33,27 +33,16 @@ config: ul-style: # MD004 style: "dash" link-fragments: false # MD051 - English anchor links in translated text fail - - # MD037: No spaces inside emphasis markers - # Covers: ** text **, __ text __, * text *, _ text _ no-space-in-emphasis: # MD037 - severity: "warning" + severity: "warning" - # MD049: Emphasis style consistency - emphasis-style: # MD049 - style: "consistent" # Allow both * and _ but be consistent - # MD050: Strong style consistency - strong-style: # MD050 - style: "consistent" # Allow both ** and __ but be consistent - - # ja-JP custom rules + # CUSTOM JAPANESE RULES (warnings only) MD-JA001: # Four consecutive asterisks (****) severity: "warning" MD-JA002: # Fullwidth asterisks (＊ should be *) severity: "warning" - MD-JA003: # Bold with parentheses **text(unit)** + MD-JA003: # Bold with bad spacing around parentheses severity: "warning" - diff --git a/doc-locale/.markdownlint/rules/bold-with-parentheses.js b/doc-locale/.markdownlint/rules/bold-with-bad-spacing.js similarity index 72% rename from doc-locale/.markdownlint/rules/bold-with-parentheses.js rename to doc-locale/.markdownlint/rules/bold-with-bad-spacing.js index dd540466515674..945ba4fdd6d882 100644 --- a/doc-locale/.markdownlint/rules/bold-with-parentheses.js +++ b/doc-locale/.markdownlint/rules/bold-with-bad-spacing.js @@ -1,6 +1,7 @@ // MD-JA003: Detect bold text containing parentheses // Pattern like **text (unit)**, **text(unit )**, **text( unit)** breaks markdown rendering in some contexts // Doesn't catch false positives when parentheses are between bold sections without spaces +// Skips code blocks and inline code module.exports = { names: ["MD-JA003", "bold-with-bad-spacing"], @@ -8,9 +9,32 @@ module.exports = { tags: ["formatting", "emphasis"], function: function rule(params, onError) { - const lines = params.lines; + const { lines, tokens } = params; // Add tokens + + // Build a set of line numbers that are in code blocks + const codeLines = new Set(); + + tokens.forEach(token => { + if (token.type === 'fence' || token.type === 'code_block') { + const startLine = token.map[0]; + const endLine = token.map[1]; + for (let i = startLine; i < endLine; i++) { + codeLines.add(i); + } + } + }); lines.forEach((line, lineIndex) => { + // Skip if this line is in a code block + if (codeLines.has(lineIndex)) { + return; + } + + // Skip lines that contain backticks (inline code) + if (line.includes('`')) { + return; + } + const boldSections = line.match(/\*\*[^*]+\*\*/g); if (!boldSections) return; @@ -24,10 +48,7 @@ module.exports = { // Exclude markdown links if (/\[[^\]]+\]\([^)]+\)/.test(content)) return; - // Exclude inline code - if (content.includes('`')) return; - - // Check for BAD spacing patterns only: + // Check for bad spacing patterns only: const hasBadSpacing = /\s{2,}[（(]/.test(content) || // 2+ spaces before ( /[（(]\s/.test(content) || // Space after ( diff --git a/doc-locale/.markdownlint/rules/no-four-asterisks.js b/doc-locale/.markdownlint/rules/no-four-asterisks.js index 67142f62697094..383d8e7d46020b 100644 --- a/doc-locale/.markdownlint/rules/no-four-asterisks.js +++ b/doc-locale/.markdownlint/rules/no-four-asterisks.js @@ -5,28 +5,76 @@ module.exports = { names: ["MD-JA001", "no-four-asterisks"], description: "Four consecutive asterisks (****) - likely a formatting error", tags: ["formatting", "emphasis"], + function: function rule(params, onError) { - const lines = params.lines; + const { lines, tokens } = params; + + // Build a map of lines that are in code blocks or inline code + const codeLines = new Set(); + const inlineCodeRanges = []; + + tokens.forEach(token => { + // Track fenced code blocks + if (token.type === 'fence' || token.type === 'code_block') { + const startLine = token.map[0]; + const endLine = token.map[1]; + for (let i = startLine; i < endLine; i++) { + codeLines.add(i); + } + } + + // Track inline code + if (token.type === 'inline' && token.children) { + token.children.forEach(child => { + if (child.type === 'code_inline') { + inlineCodeRanges.push({ + line: child.lineNumber - 1, // Convert to 0-indexed + content: child.content + }); + } + }); + } + }); lines.forEach((line, lineIndex) => { + // Skip if entire line is in a code block + if (codeLines.has(lineIndex)) { + return; + } + // Find all occurrences of four or more asterisks const fourAsteriskPattern = /\*{4,}/g; let match; while ((match = fourAsteriskPattern.exec(line)) !== null) { + // Check if this match is inside inline code + const matchStart = match.index; + const matchEnd = match.index + match[0].length; + + const isInInlineCode = inlineCodeRanges.some(range => { + if (range.line !== lineIndex) return false; + + // Check if the asterisks appear in this inline code section + const codeStart = line.indexOf('`' + range.content); + const codeEnd = codeStart + range.content.length + 2; // +2 for backticks + + return matchStart >= codeStart && matchEnd <= codeEnd; + }); + + if (isInInlineCode) { + continue; // Skip if in inline code + } + const asteriskCount = match[0].length; - const column = match.index + 1; // 1-indexed column + const column = match.index + 1; - // Determine the most likely fix based on context let fixInfo = null; let detail = ""; if (asteriskCount === 4) { - // Check if it's likely meant to be closing and opening bold const before = line.substring(0, match.index); const after = line.substring(match.index + 4); - // If there's content before and after, suggest adding space if (before.match(/[^\s*]$/) && after.match(/^[^\s*]/)) { fixInfo = { editColumn: column, diff --git a/doc-locale/.markdownlint/rules/no-fullwidth-asterisks.js b/doc-locale/.markdownlint/rules/no-fullwidth-asterisks.js index 868812b55f7387..2c9e4c4c14a0af 100644 --- a/doc-locale/.markdownlint/rules/no-fullwidth-asterisks.js +++ b/doc-locale/.markdownlint/rules/no-fullwidth-asterisks.js @@ -4,18 +4,60 @@ module.exports = { names: ["MD-JA002", "no-fullwidth-asterisks"], description: "Fullwidth asterisks (＊) should be halfwidth (*)", - tags: ["formatting", "ja-JP", "emphasis"], + tags: ["formatting", "japanese"], function: function rule(params, onError) { - const lines = params.lines; + const { lines, tokens } = params; + + // Build a map of lines in code blocks + const codeLines = new Set(); + const inlineCodeRanges = []; + + tokens.forEach(token => { + if (token.type === 'fence' || token.type === 'code_block') { + const startLine = token.map[0]; + const endLine = token.map[1]; + for (let i = startLine; i < endLine; i++) { + codeLines.add(i); + } + } + + if (token.type === 'inline' && token.children) { + token.children.forEach(child => { + if (child.type === 'code_inline') { + inlineCodeRanges.push({ + line: child.lineNumber - 1, + content: child.content + }); + } + }); + } + }); lines.forEach((line, lineIndex) => { - // Find all occurrences of fullwidth asterisk (＊) + // Skip code blocks + if (codeLines.has(lineIndex)) { + return; + } + const fullwidthPattern = /＊/g; let match; while ((match = fullwidthPattern.exec(line)) !== null) { - const column = match.index + 1; // 1-indexed column + // Check if in inline code + const matchPos = match.index; + const isInInlineCode = inlineCodeRanges.some(range => { + if (range.line !== lineIndex) return false; + const codeStart = line.indexOf('`' + range.content); + const codeEnd = codeStart + range.content.length + 2; + return matchPos >= codeStart && matchPos <= codeEnd; + }); + + if (isInInlineCode) { + continue; + } + + const column = match.index + 1; onError({ lineNumber: lineIndex + 1, -- GitLab From 54dda9667023a96dd54e103d57eb81c405531663 Mon Sep 17 00:00:00 2001 From: rasamhossain Date: Wed, 22 Oct 2025 16:42:04 -0400 Subject: [PATCH 4/7] Markdown files fixed --- .../ja-jp/administration/reference_architectures/3k_users.md | 4 ++-- doc-locale/ja-jp/install/aws/_index.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc-locale/ja-jp/administration/reference_architectures/3k_users.md b/doc-locale/ja-jp/administration/reference_architectures/3k_users.md index 8a3349bf907f6f..b957445a5691e4 100644 --- a/doc-locale/ja-jp/administration/reference_architectures/3k_users.md +++ b/doc-locale/ja-jp/administration/reference_architectures/3k_users.md @@ -888,7 +888,7 @@ Redisのセットアップの要件は次のとおりです。 {{< alert type="warning" >}} -**Gitalyの仕様は、正常に稼働する環境での利用パターンとリポジトリサイズの上位パーセンタイルに基づいています。****ただし、（数ギガバイトを超える）[大規模なモノレポ](_index.md#large-monorepos)または[追加のワークロード](_index.md#additional-workloads)がある場合、これらは環境のパフォーマンスに大きく影響することがあり、さらなる調整が必要になる場合があります**。これがあてはまると思われる場合は、必要に応じて追加のガイダンスについてお問い合わせください。 +**Gitalyの仕様は、正常に稼働する環境での利用パターンとリポジトリサイズの上位パーセンタイルに基づいています。ただし、（数ギガバイトを超える）[大規模なモノレポ](_index.md#large-monorepos)または[追加のワークロード](_index.md#additional-workloads)がある場合、これらは環境のパフォーマンスに大きく影響することがあり、さらなる調整が必要になる場合があります**。これがあてはまると思われる場合は、必要に応じて追加のガイダンスについてお問い合わせください。 {{< /alert >}} @@ -1190,7 +1190,7 @@ Praefectノードを設定するには、各ノードで次の手順を実行し {{< alert type="warning" >}} -**Gitalyの仕様は、正常に稼働する環境での利用パターンとリポジトリサイズの上位パーセンタイルに基づいています。****ただし、（数ギガバイトを超える）[大規模なモノレポ](_index.md#large-monorepos)または[追加のワークロード](_index.md#additional-workloads)がある場合、これらは環境のパフォーマンスに大きく影響することがあり、さらなる調整が必要になる場合があります**。これがあてはまると思われる場合は、必要に応じて追加のガイダンスについてお問い合わせください。 +**Gitalyの仕様は、正常に稼働する環境での利用パターンとリポジトリサイズの上位パーセンタイルに基づいています。ただし、（数ギガバイトを超える）[大規模なモノレポ](_index.md#large-monorepos)または[追加のワークロード](_index.md#additional-workloads)がある場合、これらは環境のパフォーマンスに大きく影響することがあり、さらなる調整が必要になる場合があります**。これがあてはまると思われる場合は、必要に応じて追加のガイダンスについてお問い合わせください。 {{< /alert >}} diff --git a/doc-locale/ja-jp/install/aws/_index.md b/doc-locale/ja-jp/install/aws/_index.md index 501595b51907bb..a739ddee00b274 100644 --- a/doc-locale/ja-jp/install/aws/_index.md +++ b/doc-locale/ja-jp/install/aws/_index.md @@ -489,7 +489,7 @@ EC2ダッシュボードから: 1. **VPC**: 先ほど作成したVPCである`gitlab-vpc`を選択します。 1. **Submet(サブネット)**: 先ほど作成したサブネットのリストから`gitlab-private-10.0.1.0`を選択します。 1. **Auto-assign Public IP(パブリックIPの自動割り当て)**: `Disable`を選択します。 - 1. **Firewall(ファイアウォール): ****Select existing security group(既存のセキュリティグループを選択)**を選択し、先ほど作成した`gitlab-loadbalancer-sec-group`を選択します。 + 1. **Firewall(ファイアウォール):**Select existing security group(既存のセキュリティグループを選択)**を選択し、先ほど作成した`gitlab-loadbalancer-sec-group`を選択します。 1. ストレージの場合、ルートボリュームはデフォルトで8 GiBであり、そこにデータを保存しないことを考えると十分なはずです。 1. すべての設定を確認し、問題なければ、**Launch Instance(インスタンスを起動)**を選択します。 @@ -750,7 +750,7 @@ EC2ダッシュボードから: 1. ルートボリュームはデフォルトで8 GiBで、データはそこに保存しないため十分です。**Configure Security Group(セキュリティグループの設定)**を選択します。 1. **Select existing security group(既存のセキュリティグループを選択)**にチェックマークを入れ、先ほど作成した`gitlab-loadbalancer-sec-group`を選択します。 1. **Network settings(ネットワーク設定)**セクションで: - 1. **Firewall(ファイアウォール): ****Select existing security group(既存のセキュリティグループを選択)**を選択し、先ほど作成した`gitlab-loadbalancer-sec-group`を選択します。 + 1. **Firewall(ファイアウォール):** Select existing security group(既存のセキュリティグループを選択)**を選択し、先ほど作成した`gitlab-loadbalancer-sec-group`を選択します。 1. **Advanced details(詳細設定)**セクションで: 1. **IAM instance profile(IAMインスタンスプロファイル):** [先ほど作成](#create-an-iam-role)した`GitLabS3Access`ロールを選択します。 1. すべての設定を確認し、問題がなければ**Create launch template(起動テンプレートを作成)**を選択します。 -- GitLab From eece2f43b76a1c3d4bc3dd3a2c33ddc792c8b7e3 Mon Sep 17 00:00:00 2001 From: rasamhossain Date: Thu, 23 Oct 2025 11:41:19 -0400 Subject: [PATCH 5/7] Removed MD-JA003 --- .../.markdownlint/.markdownlint-cli2.yaml | 1 - .../rules/bold-with-bad-spacing.js | 80 ------------------- 2 files changed, 81 deletions(-) delete mode 100644 doc-locale/.markdownlint/rules/bold-with-bad-spacing.js diff --git a/doc-locale/.markdownlint/.markdownlint-cli2.yaml b/doc-locale/.markdownlint/.markdownlint-cli2.yaml index e691161774aa11..c780f13f65571b 100644 --- a/doc-locale/.markdownlint/.markdownlint-cli2.yaml +++ b/doc-locale/.markdownlint/.markdownlint-cli2.yaml @@ -6,7 +6,6 @@ customRules: - rules/no-four-asterisks.js - rules/no-fullwidth-asterisks.js - - rules/bold-with-bad-spacing.js config: # First, set the default diff --git a/doc-locale/.markdownlint/rules/bold-with-bad-spacing.js b/doc-locale/.markdownlint/rules/bold-with-bad-spacing.js deleted file mode 100644 index 945ba4fdd6d882..00000000000000 --- a/doc-locale/.markdownlint/rules/bold-with-bad-spacing.js +++ /dev/null @@ -1,80 +0,0 @@ -// MD-JA003: Detect bold text containing parentheses -// Pattern like **text (unit)**, **text(unit )**, **text( unit)** breaks markdown rendering in some contexts -// Doesn't catch false positives when parentheses are between bold sections without spaces -// Skips code blocks and inline code - -module.exports = { - names: ["MD-JA003", "bold-with-bad-spacing"], - description: "Bold with parentheses has incorrect spacing", - tags: ["formatting", "emphasis"], - - function: function rule(params, onError) { - const { lines, tokens } = params; // Add tokens - - // Build a set of line numbers that are in code blocks - const codeLines = new Set(); - - tokens.forEach(token => { - if (token.type === 'fence' || token.type === 'code_block') { - const startLine = token.map[0]; - const endLine = token.map[1]; - for (let i = startLine; i < endLine; i++) { - codeLines.add(i); - } - } - }); - - lines.forEach((line, lineIndex) => { - // Skip if this line is in a code block - if (codeLines.has(lineIndex)) { - return; - } - - // Skip lines that contain backticks (inline code) - if (line.includes('`')) { - return; - } - - const boldSections = line.match(/\*\*[^*]+\*\*/g); - - if (!boldSections) return; - - boldSections.forEach(boldSection => { - const content = boldSection.slice(2, -2); - - // Only check if it has parentheses - if (!/[（(]/.test(content)) return; - - // Exclude markdown links - if (/\[[^\]]+\]\([^)]+\)/.test(content)) return; - - // Check for bad spacing patterns only: - const hasBadSpacing = - /\s{2,}[（(]/.test(content) || // 2+ spaces before ( - /[（(]\s/.test(content) || // Space after ( - /\s[）)]/.test(content); // Space before ) - - if (hasBadSpacing) { - const column = line.indexOf(boldSection) + 1; - - let detail = "Bold has incorrect spacing around parentheses"; - if (/\s{2,}[（(]/.test(content)) { - detail = "Multiple spaces before opening parenthesis"; - } else if (/[（(]\s/.test(content)) { - detail = "Space after opening parenthesis - should be removed"; - } else if (/\s[）)]/.test(content)) { - detail = "Space before closing parenthesis - should be removed"; - } - - onError({ - lineNumber: lineIndex + 1, - detail: detail, - context: line.trim(), - range: [column, boldSection.length], - fixInfo: null - }); - } - }); - }); - } -}; -- GitLab From f32d27c5e8f622e950e44c20957c12f6f692c756 Mon Sep 17 00:00:00 2001 From: Rasam Hossain Date: Fri, 24 Oct 2025 11:43:52 -0400 Subject: [PATCH 6/7] Applied changes suggested --- doc-locale/.markdownlint/.markdownlint-cli2.yaml | 6 +----- .../administration/reference_architectures/3k_users.md | 4 ++-- doc-locale/ja-jp/install/aws/_index.md | 2 +- 3 files changed, 4 insertions(+), 8 deletions(-) diff --git a/doc-locale/.markdownlint/.markdownlint-cli2.yaml b/doc-locale/.markdownlint/.markdownlint-cli2.yaml index c780f13f65571b..8166582928c6b9 100644 --- a/doc-locale/.markdownlint/.markdownlint-cli2.yaml +++ b/doc-locale/.markdownlint/.markdownlint-cli2.yaml @@ -33,8 +33,7 @@ config: style: "dash" link-fragments: false # MD051 - English anchor links in translated text fail no-space-in-emphasis: # MD037 - severity: "warning" - + severity: "error" # CUSTOM JAPANESE RULES (warnings only) MD-JA001: # Four consecutive asterisks (****) @@ -42,6 +41,3 @@ config: MD-JA002: # Fullwidth asterisks (＊ should be *) severity: "warning" - - MD-JA003: # Bold with bad spacing around parentheses - severity: "warning" diff --git a/doc-locale/ja-jp/administration/reference_architectures/3k_users.md b/doc-locale/ja-jp/administration/reference_architectures/3k_users.md index b957445a5691e4..d9b58db011c93f 100644 --- a/doc-locale/ja-jp/administration/reference_architectures/3k_users.md +++ b/doc-locale/ja-jp/administration/reference_architectures/3k_users.md @@ -888,7 +888,7 @@ Redisのセットアップの要件は次のとおりです。 {{< alert type="warning" >}} -**Gitalyの仕様は、正常に稼働する環境での利用パターンとリポジトリサイズの上位パーセンタイルに基づいています。ただし、（数ギガバイトを超える）[大規模なモノレポ](_index.md#large-monorepos)または[追加のワークロード](_index.md#additional-workloads)がある場合、これらは環境のパフォーマンスに大きく影響することがあり、さらなる調整が必要になる場合があります**。これがあてはまると思われる場合は、必要に応じて追加のガイダンスについてお問い合わせください。 +Gitalyの仕様は、正常に稼働する環境での利用パターンとリポジトリサイズの上位パーセンタイルに基づいています。ただし、（数ギガバイトを超える）[大規模なモノレポ](_index.md#large-monorepos)または[追加のワークロード](_index.md#additional-workloads)がある場合、これらは環境のパフォーマンスに大きく影響することがあり、さらなる調整が必要になる場合があります。これがあてはまると思われる場合は、必要に応じて追加のガイダンスについてお問い合わせください。 {{< /alert >}} @@ -1190,7 +1190,7 @@ Praefectノードを設定するには、各ノードで次の手順を実行し {{< alert type="warning" >}} -**Gitalyの仕様は、正常に稼働する環境での利用パターンとリポジトリサイズの上位パーセンタイルに基づいています。ただし、（数ギガバイトを超える）[大規模なモノレポ](_index.md#large-monorepos)または[追加のワークロード](_index.md#additional-workloads)がある場合、これらは環境のパフォーマンスに大きく影響することがあり、さらなる調整が必要になる場合があります**。これがあてはまると思われる場合は、必要に応じて追加のガイダンスについてお問い合わせください。 +Gitalyの仕様は、正常に稼働する環境での利用パターンとリポジトリサイズの上位パーセンタイルに基づいています。ただし、（数ギガバイトを超える）[大規模なモノレポ](_index.md#large-monorepos)または[追加のワークロード](_index.md#additional-workloads)がある場合、これらは環境のパフォーマンスに大きく影響することがあり、さらなる調整が必要になる場合があります。これがあてはまると思われる場合は、必要に応じて追加のガイダンスについてお問い合わせください。 {{< /alert >}} diff --git a/doc-locale/ja-jp/install/aws/_index.md b/doc-locale/ja-jp/install/aws/_index.md index a739ddee00b274..da6bf426a23689 100644 --- a/doc-locale/ja-jp/install/aws/_index.md +++ b/doc-locale/ja-jp/install/aws/_index.md @@ -489,7 +489,7 @@ EC2ダッシュボードから: 1. **VPC**: 先ほど作成したVPCである`gitlab-vpc`を選択します。 1. **Submet(サブネット)**: 先ほど作成したサブネットのリストから`gitlab-private-10.0.1.0`を選択します。 1. **Auto-assign Public IP(パブリックIPの自動割り当て)**: `Disable`を選択します。 - 1. **Firewall(ファイアウォール):**Select existing security group(既存のセキュリティグループを選択)**を選択し、先ほど作成した`gitlab-loadbalancer-sec-group`を選択します。 + 1. **Firewall**: **Select existing security group**を選択し、先ほど作成した`gitlab-loadbalancer-sec-group`を選択します。 1. ストレージの場合、ルートボリュームはデフォルトで8 GiBであり、そこにデータを保存しないことを考えると十分なはずです。 1. すべての設定を確認し、問題なければ、**Launch Instance(インスタンスを起動)**を選択します。 -- GitLab From ad000fd5c7fd65382733930d8948a28d2d82e201 Mon Sep 17 00:00:00 2001 From: rasamhossain Date: Fri, 24 Oct 2025 12:24:49 -0400 Subject: [PATCH 7/7] Severity implictly set --- doc-locale/.markdownlint/.markdownlint-cli2.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc-locale/.markdownlint/.markdownlint-cli2.yaml b/doc-locale/.markdownlint/.markdownlint-cli2.yaml index 8166582928c6b9..7436025cfc253d 100644 --- a/doc-locale/.markdownlint/.markdownlint-cli2.yaml +++ b/doc-locale/.markdownlint/.markdownlint-cli2.yaml @@ -32,8 +32,7 @@ config: ul-style: # MD004 style: "dash" link-fragments: false # MD051 - English anchor links in translated text fail - no-space-in-emphasis: # MD037 - severity: "error" + no-space-in-emphasis: true # MD037 # CUSTOM JAPANESE RULES (warnings only) MD-JA001: # Four consecutive asterisks (****) -- GitLab