Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[docs] docs: fix stale references and broken links in doc/

Aperta
  • Qualcosa non va?
#49,145 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
20/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Review the six listed files under doc/dev/, then compare their links and references with the named source files, including eng/tools/azure-sdk-tools/azpysdk/changelog.py. Verify that referenced files, anchors, version names, and changelog commands match the current repository, with no stale or broken references remaining.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

agentic-workflows automated documentation

[!TIP]
Your pull request is ready to create! 🎉 ✅

Everything is OK—the changes have been pushed to branch docs/fix-doc-consistency-issues-6d40b3307fc2fa8e. Please review the changes, including any protected files, before creating the pull request.

Create the pull request

The original pull request description is below.

This PR fixes several documentation inconsistencies found under doc/ where instructions or links no longer matched the current source code / repository structure.

Changes

  • doc/dev/mgmt/tests.md — The sample conftest.py link pointed to sdk/advisor/azure-mgmt-advisor/tests/conftest.py, which no longer exists. Replaced with an existing example (sdk/monitor/azure-mgmt-monitor/tests/conftest.py).
  • doc/dev/mgmt/mgmt_release.md — Referenced the version file as version.py; the generated file is actually named _version.py (leading underscore) across all mgmt packages. Fixed the path.
  • doc/dev/customize_long_running_operation.md — Several GitHub line-number anchors into base_polling.py/async_base_polling.py were stale after the source file changed (e.g. OperationResourcePolling moved from line 178 to 311, LROBasePolling from 357 to 896, etc.). Updated all six anchors to the current line numbers.
  • doc/dev/package_version/package_version_rule.md — Example links were pinned to old commit SHAs pointing at files that no longer exist (_network_management_client.py was renamed to _client.py). Replaced with a current, non-pinned link to a package (kubernetesconfiguration) that still exposes DEFAULT_API_VERSION in its current form.
  • doc/dev/code_snippets.md — The asyncio snippet example line reference (#L63-L68) was off by one compared to the actual markers in test_example_async.py (#L64-L69). Fixed.
  • doc/dev/changelog_updates.md — The doc only documented raw npx chronus ... commands. Added a note about the azpysdk changelog wrapper (add/verify/create/status), which is implemented in eng/tools/azure-sdk-tools/azpysdk/changelog.py and is the standard CLI entry point used elsewhere in the docs.

Verification

Each change was verified directly against the current repository source (file existence, class/line locations in azure-core's polling module, _version.py naming convention across mgmt packages, and the azpysdk changelog subcommands in changelog.py).

No broken markdown links, stale tox/setup.py-as-primary-workflow references, or other major contradictions were found in the remaining doc/ files during this review.

[!NOTE]
GitHub Actions is not permitted to create or approve pull requests in this repository.

The changes have been pushed to branch docs/fix-doc-consistency-issues-6d40b3307fc2fa8e and are ready to review.

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 (39 of 136 lines) 
From ab9d1f84a34b8f14525a5f79aff3ee22af734ae2 Mon Sep 17 00:00:00 2001
X-GH-AW-Base-Commit: 7d22d071f0ac60c50644c3ac32a1471bdcf64cbb
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Tue, 22 Sep 2026 22:42:08 +0000
Subject: [PATCH] docs: fix stale references and broken links under doc/

- mgmt/tests.md: replace broken conftest.py link (azure-mgmt-advisor no
  longer has a tests/conftest.py) with an existing example
  (azure-mgmt-monitor).
- mgmt/mgmt_release.md: correct version file name from version.py to
  _version.py, matching the actual generated file name.
- customize_long_running_operation.md: update stale GitHub line-number
  anchors for polling classes in base_polling.py/async_base_polling.py
  to their current locations.
- package_version/package_version_rule.md: replace broken commit-pinned
  links (network package's _network_management_client.py no longer
  exists, renamed to _client.py) with current, non-pinned links using a
  package that still exposes DEFAULT_API_VERSION.
- code_snippets.md: fix off-by-one line reference for the asyncio
  snippet example in test_example_async.py.
- changelog_updates.md: mention the azpysdk changelog wrapper
  (add/verify/create/status) alongside raw npx chronus usage, since
  azpysdk is the documented standard CLI entrypoint elsewhere in the
  docs.

Co-authored-by: Copilot <[email protected]>
---
 doc/dev/changelog_updates.md                    |  2 ++
 doc/dev/code_snippets.md                        |  2 +-
 doc/dev/customize_long_running_operation.md     | 12 ++++++------
 doc/dev/mgmt/mgmt_release.md                    |  2 +-
 doc/dev/mgmt/tests.md                           |  2 +-
 doc/dev/package_version/package_version_rule.md |  6 +++---
 6 files changed, 14 insertions(+), 12 deletions(-)

diff --git a/doc/dev/changelog_updates.md b/doc/dev/changelog_updates.md
index 21515eb59f..ec78adc32e 100644
--- a/doc/dev/changelog_updates.md
+++ b/doc/dev/changelog_
... (truncated)

[!WARNING]

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • github.com

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "github.com"

See Network Configuration for more information.

Generated by Documentation Consistency Check · copilot · sonnet50 · 208.2 AIC · ⌖ 8.63 AIC · ⊞ 7.7K · ◷

Lingua principale
Python
Stelle
5.6k
Fork
3.4k
Merge medio
2g 1h
PR unite (30g)
213

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Azure/azure-sdk-for-python

Tutte le issue di Azure/azure-sdk-for-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.