Skip to content
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.

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

Updated readme as referenced in issue 14021 #19954

Merged
merged 2 commits into from
Oct 28, 2022

Conversation

mikefrobbins
Copy link
Contributor

Description

Updated the repo readme as referenced in issue #14021

Checklist

  • SHOULD select appropriate branch. Cmdlets from Autorest.PowerShell should go to generation branch.
  • SHOULD make the title of PR clear and informative, and in the present imperative tense.
  • SHOULD update ChangeLog.md file(s) appropriately
    • For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
    • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense. Add changelog in description section if PR goes into generation branch.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD have approved design review for the changes in this repository (Microsoft internal only) with following situations
    • Create new module from scratch
    • Create new resource types which are not easy to conform to Azure PowerShell Design Guidelines
    • Create new resource type which name doesn't use module name as prefix
    • Have design question before implementation
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT introduce breaking changes in Az minor release except preview version.
  • SHOULD NOT adjust version of module manually in pull request

@mikefrobbins mikefrobbins requested a review from dcaro October 26, 2022 22:12
@vidai-msft vidai-msft self-assigned this Oct 27, 2022
Copy link
Contributor

@dcaro dcaro left a comment

Choose a reason for hiding this comment

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

Thanks for this PR, can we reduce the amount of content that we have here so it is more direct to the point and have pointers to our conceptual docs?
It seems there is an opportunity to connect more with docs and have more content on docs.

@mikefrobbins
Copy link
Contributor Author

@dcaro, Let's merge these changes as the existing documentation is completely outdated. I'll create a task for myself to iterate from there with the changes you've requested.

@@ -91,20 +106,21 @@ Set-AzContext -Subscription $SubscriptionName -Name 'MyContext'
Get-AzSubscription -SubscriptionName $SubscriptionName | Set-AzContext -Name 'MyContext'
```

For details on Azure PowerShell contexts, see our [persisted credentials guide][PersistedCredentialsGuide].
For details on Azure PowerShell contexts, see [Azure PowerShell context objects][PersistedCredentialsGuide].

### Discovering cmdlets
Copy link
Member

Choose a reason for hiding this comment

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

This section becomes different since we improved cmdlet discoverability. We can merge it at first and consider to update this section based on new experience.

@dcaro dcaro merged commit 3c1572d into Azure:main Oct 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants