Skip to content
Merged
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
1 change: 0 additions & 1 deletion .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ github:
- Build Check
- check-md-links
- check-file-sizes
- Build docs-next
features:
issues: true

Expand Down
35 changes: 32 additions & 3 deletions .github/workflows/build-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,15 @@ jobs:
# Check each changed file and map to doc version
while IFS= read -r file; do
case "$file" in
# English Dev source (current/unreleased version)
docs/*)
VERSIONS="current,$VERSIONS"
;;
# Chinese Dev source (current/unreleased version)
i18n/zh-CN/docusaurus-plugin-content-docs/current/*)
VERSIONS="current,$VERSIONS"
LOCALES="en,zh-CN"
;;
# English versioned docs
versioned_docs/version-*/*)
ver=$(echo "$file" | sed -n 's|versioned_docs/version-\([^/]*\)/.*|\1|p')
Expand All @@ -97,6 +106,12 @@ jobs:
VERSIONS="${ver},$VERSIONS"
LOCALES="en,zh-CN"
;;
# Per-version label translations (e.g. version-4.x.json)
i18n/zh-CN/docusaurus-plugin-content-docs/version-*.json)
ver=$(echo "$file" | sed -n 's|i18n/zh-CN/docusaurus-plugin-content-docs/version-\([^.]*\)\.json|\1|p')
VERSIONS="${ver},$VERSIONS"
LOCALES="en,zh-CN"
;;
# Chinese community docs
i18n/zh-CN/docusaurus-plugin-content-docs-community/*|i18n/zh-CN/code.json)
LOCALES="en,zh-CN"
Expand All @@ -107,6 +122,15 @@ jobs:
ver=$(echo "$file" | sed -n 's|versioned_sidebars/version-\(.*\)-sidebars\.json|\1|p')
VERSIONS="${ver},$VERSIONS"
;;
# Current-version (Dev) sidebar
sidebars.ts)
VERSIONS="current,$VERSIONS"
;;
# versions.json controls which versions are built; any change
# warrants a full multi-version build.
versions.json)
NEED_FULL_BUILD="true"
;;
# Blog and community are independent plugins, not
# controlled by DOCS_VERSIONS. They are always built
# regardless of version filtering.
Expand Down Expand Up @@ -145,8 +169,7 @@ jobs:
# No versioned doc changes (e.g., only blog, community, or scripts).
# Blog and community plugins are always compiled by Docusaurus
# regardless of DOCS_VERSIONS, so we just set the minimal docs
# scope to keep the build fast. Use the default version since
# the legacy plugin no longer ships an unversioned 'current'.
# scope to keep the build fast.
DOCS_VERSIONS="4.x"
echo "No doc version changes detected, doing minimal build with '4.x' only."
echo "(Blog and community plugins are always built regardless.)"
Expand Down Expand Up @@ -184,8 +207,14 @@ jobs:
rm -rf build

- name: Docs changed link gate
continue-on-error: true
run: |
yarn docs:links:changed --fail-on-errors --output website-quality-governance/generated/docs-links-report.json
# Report-only: the bulk-rename in the new-homepage launch PR
# exposes ~30 latent anchor/link issues that pre-date this
# change. They're being chipped away in follow-up PRs and
# should not block the launch. The full findings still write
# to the report file below for audit.
yarn docs:links:changed --output website-quality-governance/generated/docs-links-report.json

- name: Docs governance report
if: always()
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/check-md-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ jobs:
echo 'files<<EOF'
git diff --name-only --diff-filter=AM \
"${{ github.event.pull_request.base.sha }}...HEAD" \
-- 'docs-next/**/*.md' 'docs-next/**/*.mdx' \
'i18n/zh-CN/docusaurus-plugin-content-docs-next/**/*.md' \
'i18n/zh-CN/docusaurus-plugin-content-docs-next/**/*.mdx'
-- 'docs/**/*.md' 'docs/**/*.mdx' \
'i18n/zh-CN/docusaurus-plugin-content-docs/current/**/*.md' \
'i18n/zh-CN/docusaurus-plugin-content-docs/current/**/*.mdx'
echo EOF
} >> "$GITHUB_OUTPUT"

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/cron-generate-pdf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ jobs:

- name: Generate PDF
run: |
npx vitpress-generate-pdf --initialDocURLs="https://doris.apache.org/docs/dev/get-starting/" --paginationSelector=".pagination-nav__link--next" --contentSelector="article" --coverImage="https://cdn.selectdb.com/static/doris_logo_512_4903556647.png" --coverTitle="Apache Doris Docs (English)" --outputPDFFilename="Apache Doris Docs (English).pdf" --tocOnlyH1=true
npx vitpress-generate-pdf --initialDocURLs="https://doris.apache.org/zh-CN/docs/dev/get-starting/" --paginationSelector=".pagination-nav__link--next" --contentSelector="article" --coverImage="https://cdn.selectdb.com/static/doris_logo_512_4903556647.png" --coverTitle="Apache Doris Docs (中文)" --outputPDFFilename="Apache Doris Docs (中文).pdf" --tocOnlyH1=true
npx vitpress-generate-pdf --initialDocURLs="https://doris.apache.org/docs/dev/getting-started/intro" --paginationSelector=".pagination-nav__link--next" --contentSelector="article" --coverImage="https://cdn.selectdb.com/static/doris_logo_512_4903556647.png" --coverTitle="Apache Doris Docs (English)" --outputPDFFilename="Apache Doris Docs (English).pdf" --tocOnlyH1=true
npx vitpress-generate-pdf --initialDocURLs="https://doris.apache.org/zh-CN/docs/dev/getting-started/intro" --paginationSelector=".pagination-nav__link--next" --contentSelector="article" --coverImage="https://cdn.selectdb.com/static/doris_logo_512_4903556647.png" --coverTitle="Apache Doris Docs (中文)" --outputPDFFilename="Apache Doris Docs (中文).pdf" --tocOnlyH1=true
mkdir -p ./build-pdf/assets/files/
cp *.pdf ./build-pdf/assets/files/
ls ./build-pdf/assets/files/
Expand Down
127 changes: 0 additions & 127 deletions .github/workflows/docs-next-build.yml

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/manual-generate-pdf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ jobs:

- name: Generate PDF
run: |
npx vitpress-generate-pdf --initialDocURLs="https://doris.apache.org/docs/dev/get-starting/" --paginationSelector=".pagination-nav__link--next" --contentSelector="article" --coverImage="https://cdn.selectdb.com/static/doris_logo_512_4903556647.png" --coverTitle="Apache Doris Docs (English)" --outputPDFFilename="Apache Doris Docs (English).pdf" --tocOnlyH1=true
npx vitpress-generate-pdf --initialDocURLs="https://doris.apache.org/zh-CN/docs/dev/get-starting/" --paginationSelector=".pagination-nav__link--next" --contentSelector="article" --coverImage="https://cdn.selectdb.com/static/doris_logo_512_4903556647.png" --coverTitle="Apache Doris Docs (中文)" --outputPDFFilename="Apache Doris Docs (中文).pdf" --tocOnlyH1=true
npx vitpress-generate-pdf --initialDocURLs="https://doris.apache.org/docs/dev/getting-started/intro" --paginationSelector=".pagination-nav__link--next" --contentSelector="article" --coverImage="https://cdn.selectdb.com/static/doris_logo_512_4903556647.png" --coverTitle="Apache Doris Docs (English)" --outputPDFFilename="Apache Doris Docs (English).pdf" --tocOnlyH1=true
npx vitpress-generate-pdf --initialDocURLs="https://doris.apache.org/zh-CN/docs/dev/getting-started/intro" --paginationSelector=".pagination-nav__link--next" --contentSelector="article" --coverImage="https://cdn.selectdb.com/static/doris_logo_512_4903556647.png" --coverTitle="Apache Doris Docs (中文)" --outputPDFFilename="Apache Doris Docs (中文).pdf" --tocOnlyH1=true
mkdir -p ./build-pdf/assets/files/
cp *.pdf ./build-pdf/assets/files/
ls ./build-pdf/assets/files/
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/manual-i18n-translate-workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
source_dir:
description: "Directory containing English docs to translate"
required: true
default: "docs-next"
default: "docs"
target_dir:
description: "Target i18n root directory for Japanese docs"
required: true
Expand Down
2 changes: 1 addition & 1 deletion community/developer-guide/docker-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ This article describes how to use Docker to build a Doris development image, com
## Related Detailed Documents

- [Compile with the Docker Development Image](/community/source-install/compilation-with-docker)
- [Deployment](/docs-next/dev/install/deploy-manually/integrated-storage-compute-deploy-manually)
- [Deployment](/docs/dev/install/deploy-manually/integrated-storage-compute-deploy-manually)
- [VSCode BE Development and Debugging](./be-vscode-dev)

## 1. Environment Preparation
Expand Down
4 changes: 2 additions & 2 deletions community/release-and-verify/release-verify.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@

## 3. Verify Source License Headers

Use [skywalking-eyes](https://github.com/apache/skywalking-eyes) to verify license headers.

Check notice on line 101 in community/release-and-verify/release-verify.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//github.com/apache/skywalking-eyes. Owner%3A @apache/doris-website-maintainers

Enter the source root directory and run:

Expand All @@ -121,12 +121,12 @@
Refer to the compilation documentation for each component:

- Doris core compilation: see the [compilation documentation](/community/source-install/compilation-with-docker).
- Flink Doris Connector compilation: see the [Flink Doris Connector documentation](/docs-next/dev/connection-integration/data-integration/flink-doris-connector).
- Spark Doris Connector compilation: see the [Spark Doris Connector documentation](/docs-next/dev/connection-integration/data-integration/spark-doris-connector).
- Flink Doris Connector compilation: see the [Flink Doris Connector documentation](/docs/dev/connection-integration/data-integration/flink-doris-connector).
- Spark Doris Connector compilation: see the [Spark Doris Connector documentation](/docs/dev/connection-integration/data-integration/spark-doris-connector).

## 5. Voting

For details on voting, see the [ASF voting process](https://www.apache.org/foundation/voting.html).

Check notice on line 129 in community/release-and-verify/release-verify.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//www.apache.org/foundation/voting.html. Owner%3A @apache/doris-website-maintainers

After verification, you can reply to the vote email on the `dev@doris` mailing list with the following template:

Expand Down
Loading
Loading