[docs] Fix documentation inconsistencies in doc/ folder
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
doc/dev/perfstress_tests.md、doc/dev/conda-builds.md、doc/dev/pylint_checking.md、doc/dev/tests.mdを、リポジトリのパスおよびリンクされたソースファイルと照合して確認します。参照されている各パス、バージョンアンカー、Key Vaultリソースリンクを検証し、そのうえで4つすべてのドキュメントに現在の参照が含まれていることを確認します。作業はpull request用に指定されたブランチへすでにstagedされています。
索引モデルが issue の本文から書いたものです。
説明
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 branchdoc/fix-documentation-inconsistencies-22e1d1be83f5f3d2.
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)
- 主要言語
- Python
- スター
- 5.6k
- フォーク
- 3.4k
- 平均マージ
- 2日 4時間
- マージ済み PR（30日）
- 200
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Azure/azure-sdk-for-python のほかの issue
-
[Teams Chatbot]: Clarify Python dev-feed publication from a branch versus PyPI release対応中かも @jianingwang123 が 4 日前に担当しました。 オープンcustomer-reported question
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
Azure/azure-sdk-for-python#49548 · コメント 1 件 · リアクション 2 件 · 担当者 2 名 ·
メンテナーはふだん 1 日以内に返信
-
Client customer-reported Hosted Agents needs-team-attention question Service Attention
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
Azure/azure-sdk-for-python#49477 · コメント 4 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
azure-ai-evaluation: a content-harm score of 0 (no harm) is parsed as NaN in _parse_content_harm_response (numeric branch uses 0 < x instead of 0 <= x)対応中かも @pujitha24 が 20 日前に担当しました。 オープンEvaluation Service Attention
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
Azure/azure-sdk-for-python#49190 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Update CODEOWNERSオープン
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
Azure/azure-sdk-for-python#49183 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
azure-ai-evaluation: PromptyEvaluatorBase falls back to the first digit anywhere in the judge's reply, and the threshold turns a stray digit into a wrong pass/fail (15 evaluators)対応中かも @wasim-builds が 14 日前に担当しました。 オープンEvaluation Service Attention
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Azure/azure-sdk-for-python#49153 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
Azure/azure-sdk-for-python の issue をすべて見る
似ている issue
-
Pull-through from gcr.io returns 500 when pulling using podman/buildah対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンIssue Triage-Needed
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
pulp/pulp_container#2581 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
521xueweihan/HelloGitHub#4040 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
ClanGenOfficial/clangen#6313 ·
メンテナーはふだん 2 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
-
bug(trainer): CustomTrainer func_args with non literal values fail inside the TrainJob対応中かも @avanishkasar が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信