Improve Task Documentation
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- azure, typescript
- 领域
- devops, documentation
调研方向
首先查看通过 UI 悬停指示器展示的任务参数信息，然后将其与链接的 Azure Pipelines 任务参考进行比较。根据现有项目材料确定哪些任务和输入属于范围；相关参数名称、类型、默认值、必需条件和示例均已在文档中提供时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
There is a significant gap in parameter input documentation.
Currently the only place to find this information I am aware of is through the UI and hover over the info indicators:
This is a huge learning curve/hurtle for customer adoption.
Here is an example from other MS tasks: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/azure-resource-manager-template-deployment-v3?view=azure-pipelines
# ARM template deployment v3
# Deploy an Azure Resource Manager (ARM) template to all the deployment scopes.
- task: AzureResourceManagerTemplateDeployment@3
inputs:
# Azure Details
deploymentScope: 'Resource Group' # 'Management Group' | 'Subscription' | 'Resource Group'. Required. Deployment scope. Default: Resource Group.
azureResourceManagerConnection: # string. Alias: ConnectedServiceName. Required. Azure Resource Manager connection.
#subscriptionId: # string. Alias: subscriptionName. Required when deploymentScope != Management Group. Subscription.
#action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'DeleteRG'. Required when deploymentScope = Resource Group. Action. Default: Create Or Update Resource Group.
#resourceGroupName: # string. Required when deploymentScope = Resource Group. Resource group.
#location: # string. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Location.
# Template
#templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Template location. Default: Linked artifact.
#csmFileLink: # string. Required when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template link.
#csmParametersFileLink: # string. Optional. Use when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters link.
#csmFile: # string. Required when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template.
#csmParametersFile: # string. Optional. Use when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters.
#overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Override template parameters.
#deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment mode. Default: Incremental.
# Advanced
#deploymentName: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment name.
#deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment outputs.
#addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Access service principal details in override parameters. Default: false.
- 主要语言
- TypeScript
- 星标
- 85
- 派生
- 22
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
microsoft/security-devops-azdevops 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 68/100
-
Checkov's SoftFail not documented, working, and ignored by MSDO可能重新可做 @DimaBir 于 128 天前认领，目前没有进行中的 PR。 未关闭area:task area:tools status:waiting-on-author type:docs type:question
microsoft/security-devops-azdevops#169 · 1 条评论 · 已指派 1 人 ·
-
Which Defender CLI binary should be used in CI/CD pipelines — `aka.ms` or the DevOps CDN endpoint?未关闭
难度 5/5 一周以上 新手友好度 35/100
microsoft/security-devops-azdevops#166 · 2 条评论 · 1 个 reaction ·
-
Spec: Promote CKV_AZUREPIPELINES_* severity from note to warning可能已有人在做 @DimaBir 于 145 天前认领。 未关闭area:task area:tools status:team-review type:feature
microsoft/security-devops-azdevops#164 · 2 个 reaction · 已指派 2 人 ·
-
Checkov tool omits Azure Pipelines results可能重新可做 @DimaBir 于 148 天前认领，目前没有进行中的 PR。 未关闭area:task area:tools status:team-review type:docs type:feature
microsoft/security-devops-azdevops#163 · 17 条评论 · 已指派 1 人 ·
查看 microsoft/security-devops-azdevops 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 85/100
farbenmeer/tapi#531 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
naver/egjs-flicking#971 ·
-
难度 1/5 1 小时以内 新手友好度 85/100
维护者通常 1 天内回复
-
Tenant
难度 2/5 1-3 小时 新手友好度 66/100
MTES-MCT/Dossier-Facile-Frontend#2061 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
backnotprop/plannotator#1784 ·
维护者通常 1 天内回复