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

Update getting started deployment docs #530

Merged
merged 1 commit into from
Jun 8, 2021

Conversation

dfarrell07
Copy link
Member

Update the deployment summary in the getting started docs to reflect the
new reality that the Operator is always used, either by subctl, Helm, or
directly. Mention new subctl features as one reason it is recommended.

This section was part of the UX failure of a recent IBM Twitch stream.

https://www.youtube.com/watch?v=98rC2OOW20w

Signed-off-by: Daniel Farrell dfarrell@redhat.com

@dfarrell07 dfarrell07 added the documentation Improvements or additions to documentation label Jun 7, 2021
@dfarrell07 dfarrell07 added this to the 0.10-m2 milestone Jun 7, 2021
@dfarrell07 dfarrell07 self-assigned this Jun 7, 2021
@netlify
Copy link

netlify bot commented Jun 7, 2021

✔️ Deploy Preview for elated-bell-2913d9 ready!

🔨 Explore the source changes: 1c54e63

🔍 Inspect the deploy log: https://app.netlify.com/sites/elated-bell-2913d9/deploys/60bf999a04acc7000796c7ca

😎 Browse the preview: https://deploy-preview-530--elated-bell-2913d9.netlify.app

@dfarrell07 dfarrell07 marked this pull request as ready for review June 7, 2021 18:02
@dfarrell07 dfarrell07 requested a review from nyechiel June 7, 2021 18:02
`subctl` greatly simplifies the deployment of Submariner, and is therefore the recommended deployment
method.
`subctl` is the recommended deployment method because it has the most refined deployment user experience and additionally provides testing,
debugging, and bug-reporting capabilities.
Copy link
Member

Choose a reason for hiding this comment

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

"bug-reporting capabilities" makes it sound like you can report a bug directly from the tool?

Copy link
Member

Choose a reason for hiding this comment

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

“bug-diagnosing” might be more accurate.

Copy link
Member Author

Choose a reason for hiding this comment

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

I meant that you can gather everything required to report a bug, I can try to make that more clear.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I understand that, just trying to make it clearer for someone who is not familiar with the tool.

Copy link
Member Author

Choose a reason for hiding this comment

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

“bug-diagnosing” might be more accurate.

This wasn't loading in for me when I originally commented, but yes that's great wording IMHO. Updated accordingly.

@dfarrell07 dfarrell07 force-pushed the deployment_summary branch from c602216 to 2e4546c Compare June 8, 2021 16:15
Update the deployment summary in the getting started docs to reflect the
new reality that the Operator is always used, either by subctl, Helm, or
directly. Mention new subctl features as one reason it is recommended.

This section was part of the UX failure of a recent IBM Twitch stream.

https://www.youtube.com/watch?v=98rC2OOW20w

Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
@dfarrell07 dfarrell07 force-pushed the deployment_summary branch from 2e4546c to 1c54e63 Compare June 8, 2021 16:23
@skitt skitt requested a review from nyechiel June 8, 2021 16:25
@nyechiel nyechiel merged commit 8398955 into submariner-io:devel Jun 8, 2021
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.

3 participants