Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[docs] Fix documentation inconsistencies in doc/ folder

Đang mở
  • Có gì không ổn?
#48,807 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Rà soát doc/dev/perfstress_tests.md, doc/dev/conda-builds.md, doc/dev/pylint_checking.md và doc/dev/tests.md dựa trên các đường dẫn trong repository và các tệp mã nguồn được liên kết. Xác minh từng đường dẫn được tham chiếu, từng version anchor và từng liên kết tài nguyên Key Vault, sau đó xác nhận cả bốn tài liệu đều chứa các tham chiếu hiện tại; phần công việc đã được staged trên branch được nêu tên cho một pull request.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

agentic-workflows automated documentation

Fixes four verified documentation inconsistencies found by reviewing all markdown files under doc/ against the current repository structure and source code.

Changes

doc/dev/perfstress_tests.md

The system-tests install command referenced a tools/devtools_testutils path that does not exist in the repository. The actual path is eng/tools/azure-sdk-tools.

Before:

pip install -e azure-sdk-for-python/tools/devtools_testutils[systemperf]

After:

pip install -e azure-sdk-for-python/eng/tools/azure-sdk-tools[systemperf]
doc/dev/conda-builds.md

The file referenced eng/conda_env.yml which does not exist. The file lives at conda/conda-recipes/conda_env.yml.

doc/dev/pylint_checking.md

The link for azure-pylint-guidelines-checker pointed to line #L61 of pylint.py, which is the register() method body — unrelated to the version. The PYLINT_GUIDELINES_CHECKER_VERSION constant is at line #L18.

doc/dev/tests.md

Three reference links for kv_test_resources pointed to a SHA-pinned, now-deleted test-resources.json file in the Key Vault SDK. That file was replaced by test-resources.bicep. Updated all three links to point to the current test-resources.bicep file on main, with corrected line anchors for the resources section (line 38) and outputs section (line 174).

Generated by Documentation Consistency Check · 199.1 AIC · ⌖ 12.6 AIC · ⊞ 5.8K · ◷

[!NOTE]
This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
The changes have been pushed to branch doc/fix-documentation-inconsistencies-22e1d1be83f5f3d2.

Click here to create the pull request

To fix the permissions issue, go to Settings → Actions → General and enable Allow GitHub Actions to create and approve pull requests. See also: gh-aw FAQ

Show patch preview (82 of 82 lines) 
From e0ffa714c6c5f4def2e3b1b9346ce3d302da544e Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Mon, 31 Aug 2026 04:55:20 +0000
Subject: [PATCH] doc: fix documentation inconsistencies

- perfstress_tests.md: fix install path from non-existent tools/ to
  eng/tools/azure-sdk-tools
- conda-builds.md: fix conda_env.yml path from eng/ to
  conda/conda-recipes/
- pylint_checking.md: fix stale line anchor #L61 to #L18 for
  PYLINT_GUIDELINES_CHECKER_VERSION
- tests.md: update kv_test_resources links from SHA-pinned deleted
  test-resources.json to main-branch test-resources.bicep

Co-authored-by: Copilot <[email protected]>
---
 doc/dev/conda-builds.md     | 2 +-
 doc/dev/perfstress_tests.md | 2 +-
 doc/dev/pylint_checking.md  | 2 +-
 doc/dev/tests.md            | 6 +++---
 4 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/dev/conda-builds.md b/doc/dev/conda-builds.md
index 72e845ce..085e8b34 100644
--- a/doc/dev/conda-builds.md
+++ b/doc/dev/conda-builds.md
@@ -12,7 +12,7 @@ Follow the instructions [here](https://docs.conda.io/projects/conda-build/en/lat
 
 - Update `CondaArtifacts` parameters as necessary within `eng/pipelines/templates/stages/conda-sdk-client.yml` .
 - If necessary, add or update the conda recipes present under `/conda/conda-recipes`.
-- Update `eng/conda_env.yml` variable `AZURESDK_CONDA_VERSION` to the target version you wish to release.
+- Update `conda/conda-recipes/conda_env.yml` variable `AZURESDK_CONDA_VERSION` to the target version you wish to release.
 - Invoke [python - conda](https://dev.azure.com/azure-sdk/internal/_build?definitionId=6321) manually, checking off which packages you wish to release.
 - Once built, approve the packages for release individually, there will be pending approval stages.
 
diff --git a/doc/dev/perfstress_tests.md b/doc/dev/perfstress_tests.md
index c0f7fa85..fe3ded40 100644
--- a/doc/dev/perfstress_tests.md
+++ b/doc/
... (truncated)
Ngôn ngữ chính
Python
Star
5.6k
Fork
3.4k
Merge trung bình
2 ngày 7 giờ
Pull request đã merge (30 ngày)
206

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Azure/azure-sdk-for-python

Tất cả issue của Azure/azure-sdk-for-python

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.