Skip to content

Update help text to include example and documentation link for securi… #837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ishitam8 merged 3 commits into from
Oct 17, 2019
Merged

Update help text to include example and documentation link for securi… #837

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b82c516
Update help text to include example and documentation link for securi…
ishitam8 Oct 16, 2019
ba0d3a8
Fixing style checks
ishitam8 Oct 16, 2019
3389ae0
Moving the reference link to long-summary
ishitam8 Oct 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions azure-devops/azext_devops/dev/team/_help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,23 @@ def load_team_help():
short-summary: Manage security namespaces
"""

helps['devops security permission update'] = """
type: group
short-summary: Assign allow or deny permission to given user/group.
Learn more at https://aka.ms/azure-devops-cli-security-permission

@atbagga atbagga Oct 16, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO learn more should go in long summary.

e.g. I would not want to show that level of details in this command:

 D:\>az devops security permission -h

Group
    az devops security permission : Manage security permissions.
        This command group is in preview. It may be changed/removed in a future release.
Subgroups:
    namespace : Manage security namespaces.

Commands:
    list      : List tokens for given user/group and namespace.
    reset     : Reset permission for given permission bit(s).
    reset-all : Clear all permissions of this token for a user/group.
    show      : Show permissions for given token, namespace and user/group.
    update    : Assign allow or deny permission to given user/group.

@ishitam8 ishitam8 Oct 16, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! I agree, it will make more sense if we include the link in the long summary.
@geverghe what do you think ?

@geverghe geverghe Oct 16, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure of how the long summary appears. @atbagga / @ishitam8 any prior examples where long summary has been used to get a sense of how it would look?

@geverghe geverghe Oct 16, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok got it; makes perfect sense. Including the reference I got from cognitive services that follows the same structure:

long-summary: This article lists the Azure CLI commands for Azure Cognitive Services account and subscription management only. Refer to the documentation at https://docs.microsoft.com/azure/cognitive-services/ for individual services to learn how to use the APIs and supported SDKs.

image

@ishitam8 ishitam8 Oct 16, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1

This is how it looks if added in long-summary with example

@atbagga atbagga Oct 18, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Raised a fix in Knack for the preview message text to start in new line.
microsoft/knack#167

long-summary:
examples:
- name: Assign view, edit and delete permission for team projects.
text: |
az devops security permission update --allow-bit 7 --namespace-id
52d39943-cb85-4d7f-8fa8-c6baac873819 --subject user@fabrikam.com
--token "$PROJECT:vstfs:///Classification/TeamProject/e479xxxx-2be8-xxxx-bb0b-3a0209cxxxx"

You would need to add the bit value of the various permission bits to
simultaneously allow/deny multiple permissions.

"""

helps['devops team'] = """
type: group
short-summary: Manage teams
Expand Down