Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/_governance-pilot/feature-doc-bad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---

Check notice on line 1 in docs/_governance-pilot/feature-doc-bad.md

View workflow job for this annotation

GitHub Actions / Build Check

i18n-sync-locale-candidate

Japanese docs are report-only. Generate a candidate translation from the changed files and merge it only after human review. Owner%3A @apache/doris-website-maintainers

Check notice on line 1 in docs/_governance-pilot/feature-doc-bad.md

View workflow job for this annotation

GitHub Actions / Build Check

i18n-sync-locale-missing

zh-CN current counterpart is missing for this English doc. Create a companion translation PR or explain the exception in the PR description. Owner%3A @apache/doris-website-maintainers
title: "Fixture: feature doc missing sections"
description: "This fixture is tagged as a feature doc but intentionally omits most required sections so that feature-doc-section-required fires for each one."
doc_type: feature
---

# Fixture: feature doc missing sections

## Random other section

Only an unrelated section is present. Overview, Quick Start,
Parameters/Options, Examples, Error handling and Best practices are all
missing on purpose.
13 changes: 13 additions & 0 deletions docs/_governance-pilot/frontmatter-missing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---

Check notice on line 1 in docs/_governance-pilot/frontmatter-missing.md

View workflow job for this annotation

GitHub Actions / Build Check

i18n-sync-locale-candidate

Japanese docs are report-only. Generate a candidate translation from the changed files and merge it only after human review. Owner%3A @apache/doris-website-maintainers

Check notice on line 1 in docs/_governance-pilot/frontmatter-missing.md

View workflow job for this annotation

GitHub Actions / Build Check

i18n-sync-locale-missing

zh-CN current counterpart is missing for this English doc. Create a companion translation PR or explain the exception in the PR description. Owner%3A @apache/doris-website-maintainers

Check warning on line 1 in docs/_governance-pilot/frontmatter-missing.md

View workflow job for this annotation

GitHub Actions / Build Check

frontmatter-description-required

Missing required front matter field%3A description. Owner%3A @apache/doris-website-maintainers

Check warning on line 1 in docs/_governance-pilot/frontmatter-missing.md

View workflow job for this annotation

GitHub Actions / Build Check

frontmatter-title-required

Missing required front matter field%3A title. Owner%3A @apache/doris-website-maintainers
language: en
---

# Fixture: frontmatter missing

This page intentionally omits both `title` and `description` front matter to
trigger the frontmatter-title-required and frontmatter-description-required
rules.

## Body

Some text to satisfy the body requirement.
16 changes: 16 additions & 0 deletions docs/_governance-pilot/frontmatter-type-errors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---

Check notice on line 1 in docs/_governance-pilot/frontmatter-type-errors.md

View workflow job for this annotation

GitHub Actions / Build Check

i18n-sync-locale-candidate

Japanese docs are report-only. Generate a candidate translation from the changed files and merge it only after human review. Owner%3A @apache/doris-website-maintainers

Check notice on line 1 in docs/_governance-pilot/frontmatter-type-errors.md

View workflow job for this annotation

GitHub Actions / Build Check

i18n-sync-locale-missing

zh-CN current counterpart is missing for this English doc. Create a companion translation PR or explain the exception in the PR description. Owner%3A @apache/doris-website-maintainers

Check warning on line 1 in docs/_governance-pilot/frontmatter-type-errors.md

View workflow job for this annotation

GitHub Actions / Build Check

frontmatter-sidebar-position-type

Front matter field sidebar_position must be a number. Owner%3A @apache/doris-website-maintainers

Check warning on line 1 in docs/_governance-pilot/frontmatter-type-errors.md

View workflow job for this annotation

GitHub Actions / Build Check

frontmatter-tags-type

Front matter field tags must be an array. Owner%3A @apache/doris-website-maintainers

Check warning on line 1 in docs/_governance-pilot/frontmatter-type-errors.md

View workflow job for this annotation

GitHub Actions / Build Check

frontmatter-keywords-type

Front matter field keywords must be a string or array. Owner%3A @apache/doris-website-maintainers

Check warning on line 1 in docs/_governance-pilot/frontmatter-type-errors.md

View workflow job for this annotation

GitHub Actions / Build Check

frontmatter-slug-type

Front matter field slug must be a string. Owner%3A @apache/doris-website-maintainers
title: "Fixture: frontmatter type errors"
description: "This fixture has frontmatter fields with the wrong types to trigger the frontmatter type rules in the docs governance lint."
slug: 12345
keywords: 42
tags: "should-be-array"
sidebar_position: "not-a-number"
---

# Fixture: frontmatter type errors

Intentionally wrong types on `slug`, `keywords`, `tags`, `sidebar_position`.

## Body

Content body.
12 changes: 12 additions & 0 deletions docs/_governance-pilot/i18n-sync-only-en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---

Check notice on line 1 in docs/_governance-pilot/i18n-sync-only-en.md

View workflow job for this annotation

GitHub Actions / Build Check

i18n-sync-locale-candidate

Japanese docs are report-only. Generate a candidate translation from the changed files and merge it only after human review. Owner%3A @apache/doris-website-maintainers

Check notice on line 1 in docs/_governance-pilot/i18n-sync-only-en.md

View workflow job for this annotation

GitHub Actions / Build Check

i18n-sync-locale-missing

zh-CN current counterpart is missing for this English doc. Create a companion translation PR or explain the exception in the PR description. Owner%3A @apache/doris-website-maintainers
title: "Fixture: i18n sync only English"
description: "This fixture intentionally ships only the English current-version copy so the i18n-sync lint reports missing zh-CN, missing 4.x, and the Japanese candidate."
---

# Fixture: i18n sync only English

This doc exists only in English `current`. The i18n sync lint should report:

- `i18n-sync-version-missing` for the 4.x counterpart
- `i18n-sync-locale-missing` for the zh-CN counterpart
- `i18n-sync-locale-candidate` for the Japanese candidate
24 changes: 24 additions & 0 deletions docs/_governance-pilot/links-broken.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---

Check notice on line 1 in docs/_governance-pilot/links-broken.md

View workflow job for this annotation

GitHub Actions / Build Check

i18n-sync-locale-missing

zh-CN current counterpart is missing for this English doc. Create a companion translation PR or explain the exception in the PR description. Owner%3A @apache/doris-website-maintainers
title: "Fixture: broken links"
description: "This fixture intentionally contains broken internal links and missing anchors to trigger the blocking changed-only link gate."
---

# Fixture: broken links

## Missing internal file

See [this missing doc](./does-not-exist.md) which should trigger the

Check failure on line 10 in docs/_governance-pilot/links-broken.md

View workflow job for this annotation

GitHub Actions / Build Check

link-missing-target

Internal link target does not exist%3A ./does-not-exist.md. Owner%3A @apache/doris-website-maintainers
internal-file-missing rule.

## Missing anchor in existing doc

See [missing anchor](../gettingStarted/what-is-apache-doris.md#this-anchor-does-not-exist)

Check failure on line 15 in docs/_governance-pilot/links-broken.md

View workflow job for this annotation

GitHub Actions / Build Check

link-missing-anchor

Anchor #this-anchor-does-not-exist does not exist in docs/gettingStarted/what-is-apache-doris.md. Owner%3A @apache/doris-website-maintainers
which should trigger the missing-anchor rule.

## Missing route

Also [this route](/docs/this-route-does-not-exist) should not resolve.

Check failure on line 20 in docs/_governance-pilot/links-broken.md

View workflow job for this annotation

GitHub Actions / Build Check

link-missing-target

Internal link target does not exist%3A /docs/this-route-does-not-exist. Owner%3A @apache/doris-website-maintainers

## External link (report-only today)

See the [example external link](https://this-domain-absolutely-does-not-exist-doris-governance.invalid/some-page).

Check notice on line 24 in docs/_governance-pilot/links-broken.md

View workflow job for this annotation

GitHub Actions / Build Check

link-external-report-only

External link is report-only and was not fetched%3A https%3A//this-domain-absolutely-does-not-exist-doris-governance.invalid/some-page. Owner%3A @apache/doris-website-maintainers
32 changes: 32 additions & 0 deletions docs/_governance-pilot/markdown-structure-bad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Fixture: markdown structure issues"
description: "This fixture intentionally violates Markdown structure rules to trigger code fence, heading and CJK spacing lints."
---

Check warning on line 4 in docs/_governance-pilot/markdown-structure-bad.md

View workflow job for this annotation

GitHub Actions / Build Check

markdown-cjk-spacing

Chinese text should contain spaces around adjacent English words or numbers. Owner%3A @apache/doris-website-maintainers

# First H1 heading

Check warning on line 6 in docs/_governance-pilot/markdown-structure-bad.md

View workflow job for this annotation

GitHub Actions / Build Check

markdown-heading-increment

Heading level jumps from H1 to H4. Owner%3A @apache/doris-website-maintainers

Some intro text in English. 这里是中文和English单词直接相连,没空格,应该触发 markdown-cjk-spacing 规则。例如 Doris3.0 这种写法也会触发。

#### Skipped from H1 to H4 to trigger heading increment rule

Check warning on line 10 in docs/_governance-pilot/markdown-structure-bad.md

View workflow job for this annotation

GitHub Actions / Build Check

markdown-empty-heading

Markdown heading text is empty. Owner%3A @apache/doris-website-maintainers

Body under an invalid heading jump.

##

Check warning on line 14 in docs/_governance-pilot/markdown-structure-bad.md

View workflow job for this annotation

GitHub Actions / Build Check

markdown-single-h1

Document should not contain multiple H1 headings. Owner%3A @apache/doris-website-maintainers

Above heading is empty so it should trigger markdown-empty-heading.

# Second H1 which should not exist

This second H1 should trigger markdown-single-h1.

## Code fence without language

```
SELECT * FROM tbl;
```

## Code fence with language (control)

```sql
SELECT 1;
```
9 changes: 9 additions & 0 deletions docs/_governance-pilot/seo-bad-a.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Fixture SEO Duplicate Title"
description: "Apache Doris documentation."
---

# Fixture SEO duplicate title (a)

Intentionally a very short and generic description. This page shares its
title with `seo-bad-b.md` to trigger the duplicate-title rule.
9 changes: 9 additions & 0 deletions docs/_governance-pilot/seo-bad-b.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Fixture SEO Duplicate Title"
description: "Docs."
---

# Fixture SEO duplicate title (b)

Intentionally duplicate title + too-short generic description to exercise
seo-title-duplicate, seo-description-length and seo-description-generic.
13 changes: 13 additions & 0 deletions docs/_governance-pilot/sidebar-orphan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Fixture: sidebar orphan"
description: "This fixture is a new doc that is intentionally not registered in sidebars.ts to trigger the sidebar orphan rule."
---

# Fixture: sidebar orphan

This doc id is not added to `sidebars.ts`, so it should be reported as an
orphan by the sidebar lint.

## Body

Nothing linkable here.
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "doris_governance_fixture_bad"
description: "Fixture SQL function documentation with intentionally broken structure to trigger the SQL function governance lint rules."
---

# doris_governance_fixture_bad

## Syntax

```sql
doris_governance_fixture_bad(expr)
```

```python
# extra code block in Syntax section to violate sql-function-syntax-sql-code-block
print("bad")
```

## Description

Intentionally placed after Syntax, violating sql-function-section-order.

## Parameters

Parameters are described as a bullet list to violate sql-function-parameters-table:

- `expr`: some expression.

## Return Value

Returns something useful.

## Example

```sql
SELECT doris_governance_fixture_bad('x');
```

No expected `text` output block is provided, so sql-function-example-output
should fire here.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
}
---

<!-- governance-pilot: fixture edit to exercise i18n-sync-source-counterpart; remove before merge -->

## Power BI

### Q1. JDBC 拉取表到 Desktop Power BI 时报错 Timeout expired. The timeout period elapsed prior to completion of the operation or the server is not responding.
Expand Down
Loading