Skip to content

[Doc] doc_source_map.json is inaccurate #27727

@jiasli

Description

@jiasli

In https://github.com/MicrosoftDocs/azure-docs-cli/blob/0836c43c2105ab63139fa5aa501ce11c45b287fe/latest/docs-ref-autogen/account/management-group/entities.yml#L17, the editLink of az account management-group entities list points to profile command module:

  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py

but the help message actually comes from resource command module:

helps['account management-group entities list'] = """

editLink is generated from

"account": "src/azure-cli/azure/cli/command_modules/profile/_help.py",

but the fact is that the relationship between command groups (account in this case) and command modules (profile in this case) is not an 1:1 or 1:N mapping, but an N:N mapping:

  1. A command module can define multiple command groups
  2. A command group can be defined by multiple command modules

Content in doc_source_map.json was first introduced by #712 and then moved to a separate file doc/sphinx/azhelpgen/doc_source_map.json in #822.

Metadata

Metadata

Assignees

Labels

Auto-AssignAuto assign by botAzure CLI TeamThe command of the issue is owned by Azure CLI teampotential-pruningquestionThe issue doesn't require a change to the product in order to be resolved. Most issues start as that

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions