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

Docs: Adding minor edits to the Quick Start Guide #22500

Merged
merged 6 commits into from
Feb 2, 2022

Conversation

coder-karen
Copy link
Contributor

Changes proposed in this Pull Request:

  • Adding information about cloning using a public SSH key
  • Minor edit to the first jetpack docker up prompt, to be jetpack docker up -d
  • Changing the Jurassic Tube wording to indicate that you need to visit the homepage in order to create the subdomain

Jetpack product discussion

n/a

Does this pull request change what data or activity we track or use?

n/a

Testing instructions:

  • Is it clear when reading through the doc that using a public SSH key is (or may be) the best choice if possible (but the HTTPS route also is still ok)? (Should we explain 'why' it may be recommended (more secure), or is that adding too much extra complexity here? Or are we already adding too much complexity by mentioning SSH now?)
  • Also is it clear that visiting the homepage of Jurassic Tube is how to create a subdomain?

@github-actions github-actions bot added the Docs label Jan 26, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jan 26, 2022

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ All commits were linted before commit.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team review" label and ask someone from your team review the code.
Once you’ve done so, switch to the "[Status] Needs Review" label; someone from Jetpack Crew will then review this PR and merge it to be included in the next Jetpack release.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 26, 2022
@coder-karen coder-karen added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jan 26, 2022
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
@sdixon194
Copy link
Contributor

Thanks for these suggestions! Some thoughts on formatting but otherwise g2g 👍

@sdixon194 sdixon194 added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Jan 26, 2022
sdixon194
sdixon194 previously approved these changes Jan 27, 2022
Copy link
Contributor

@sdixon194 sdixon194 left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for updating!

@sdixon194 sdixon194 added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jan 27, 2022
@coder-karen coder-karen added [Status] In Progress and removed [Status] Ready to Merge Go ahead, you can push that green button! labels Jan 27, 2022
@coder-karen coder-karen added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] In Progress labels Jan 27, 2022
@jeherve jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Jan 27, 2022
@jeherve jeherve enabled auto-merge (squash) January 28, 2022 11:48
@jeherve jeherve merged commit b984aa7 into master Feb 2, 2022
@jeherve jeherve deleted the update/quick-start-docs-readme branch February 2, 2022 16:40
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants