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

fix edge cases in docs #2024

Merged
merged 2 commits into from
Apr 20, 2022
Merged

fix edge cases in docs #2024

merged 2 commits into from
Apr 20, 2022

Conversation

qpetraroia
Copy link
Contributor

@qpetraroia qpetraroia commented Apr 18, 2022

What does this change

I recently got Porter running on my M1 mac. During my set up, I ran into a couple of problems. One being using the wrong prerelease version of Porter as well as port 5000 being blocked by Mac OS Monterey.

For example if it introduces a new command or modifies a commands output, give an example of you running the command and showing real output here.

What issue does it fix

Closes # (issue)

If there is not an existing issue, please make sure we have context on why this change is needed. See our Contributing Guide for examples of when an existing issue isn't necessary.

Notes for the reviewer

Put any questions or notes for the reviewer here.

Checklist

  • Did you write tests?
  • Did you write documentation?
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Reviewer Checklist

  • Comment with /azp run test-porter-release if a magefile or build script was modified
  • Comment with /azp run porter-integration if it's a non-trivial PR

Signed-off-by: Quentin Petraroia <q.petraroia@gmail.com>
Copy link
Member

@carolynvs carolynvs 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 helping us keep our introductory docs up to date! 💯

@@ -394,6 +394,8 @@ Hello Carolyn!
That verifies your change but let's also run the [unit tests] and [end-to-end] tests
to make sure there aren't any regressions.

> In MacOS Monterey, port 5000 is already in use blocking `mage testSmoke` from running properly. To free port 5000, uncheck `AirPlay Receiver` in Sharing under System Preferences.
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for adding this! I ran into the same problem myself but then immediately forgot that I had to do that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I know right!? It was driving me crazy LOL!

@carolynvs
Copy link
Member

@qpetraroia Would you like to add your name to our CONTRIBUTORS page as part of this PR before I merge it? You can always add it later if you like.

@carolynvs carolynvs self-assigned this Apr 19, 2022
@qpetraroia
Copy link
Contributor Author

@qpetraroia Would you like to add your name to our CONTRIBUTORS page as part of this PR before I merge it? You can always add it later if you like.

Yep, I will do this later tonight!

Signed-off-by: Quentin Petraroia <q.petraroia@gmail.com>
@qpetraroia
Copy link
Contributor Author

@carolynvs added myself to the list :) looking forward to contributing more in my spare time!

@carolynvs carolynvs merged commit 0038f3c into getporter:main Apr 20, 2022
@carolynvs carolynvs mentioned this pull request May 25, 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.

2 participants