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

Improve documentation for running the port_quota demo. #3196

Merged
merged 2 commits into from
Feb 13, 2024

Conversation

ben-zen
Copy link
Contributor

@ben-zen ben-zen commented Jan 24, 2024

Resolves: #3192

Description

This change expands the documentation of the port_quota example to work around a number of potential issues a new user may encounter when attempting to run the demo, because the existing documentation was very incomplete.
 

Testing

This change does not include any code changes.

Documentation

Is there any documentation impact for this change? Yes, see description.

Installation

Is there any installer impact for this change? No. This is a docs-only change.

docs/GettingStarted.md Outdated Show resolved Hide resolved
@dthaler dthaler added the documentation Improvements or additions to documentation label Jan 25, 2024
dthaler
dthaler previously approved these changes Jan 25, 2024
Copy link
Collaborator

@dthaler dthaler 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 contribution! Definitely an improvement.

docs/GettingStarted.md Outdated Show resolved Hide resolved
docs/GettingStarted.md Outdated Show resolved Hide resolved
@saxena-anurag saxena-anurag added this pull request to the merge queue Feb 13, 2024
Merged via the queue into microsoft:main with commit 87ab9a9 Feb 13, 2024
75 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

port_quota demo instructions were lacking and somewhat inaccurate
4 participants