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.

Sign up for GitHub

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

Jump to bottom

Update user facing documentation for v0.8.0 release #115

Merged
merged 3 commits into from
Jul 30, 2021
Merged

Update user facing documentation for v0.8.0 release #115

merged 3 commits into from
Jul 30, 2021

Conversation

roivaz
Copy link
Member

@roivaz roivaz commented Jul 28, 2021

This PR updates all the user facing documentation, which is basically everything but the design docs:

  • Updated the README
  • Added several walkthroughs to showcase the different features
  • Removed the original quickstart example from the main readme and converted into one of the several walkthoughs

/kind documentation
/priority important-soon
/assign

@3scale-robot 3scale-robot added kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next sprint. labels Jul 28, 2021
@3scale-robot 3scale-robot added needs-size Indicates a PR or issue lacks a `size/foo` label and requires one. size/L Requires few days to complete the PR or the issue. and removed needs-size Indicates a PR or issue lacks a `size/foo` label and requires one. labels Jul 28, 2021
@roivaz
Copy link
Member Author

roivaz commented Jul 28, 2021

/ok-to-test

@3scale-robot 3scale-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Jul 28, 2021
@roivaz roivaz removed the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Jul 28, 2021
@roivaz
Copy link
Member Author

roivaz commented Jul 28, 2021

/ok-to-test

@3scale-robot 3scale-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Jul 28, 2021
@slopezz
Copy link
Member

slopezz commented Jul 29, 2021

/lgtm

@3scale-robot 3scale-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 29, 2021
@3scale-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 4345dc7550c0ba295214478b124e5d8a916b0dc7

raelga
raelga reviewed Jul 30, 2021
View reviewed changes
Copy link
Contributor

@raelga raelga left a comment

Choose a reason for hiding this comment

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

Some rewording and typo fixes.

docs/walkthroughs/configuration-validation.md Outdated Show resolved Hide resolved
docs/walkthroughs/configuration-validation.md Outdated Show resolved Hide resolved
docs/walkthroughs/configuration-validation.md Outdated Show resolved Hide resolved
docs/walkthroughs/envoy-connection-draining-on-shutdown.md Outdated Show resolved Hide resolved
docs/walkthroughs/envoy-connection-draining-on-shutdown.md Outdated Show resolved Hide resolved
docs/walkthroughs/tls-offloading-sidecars.md Outdated Show resolved Hide resolved
docs/walkthroughs/tls-offloading-sidecars.md Outdated Show resolved Hide resolved
docs/walkthroughs/tls-offloading-sidecars.md Outdated Show resolved Hide resolved
docs/walkthroughs/upgrading-v2-to-v3.md Outdated Show resolved Hide resolved
docs/walkthroughs/upgrading-v2-to-v3.md Outdated Show resolved Hide resolved
@3scale-robot 3scale-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 30, 2021
@roivaz @raelga
Fix typos and improve some expressions
cea9877 
Co-authored-by: Rael Garcia <rael@redhat.com>
raelga
raelga approved these changes Jul 30, 2021
View reviewed changes
Copy link
Contributor

@raelga raelga left a comment

Choose a reason for hiding this comment

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

/lgtm

@3scale-robot 3scale-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 30, 2021
@3scale-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 4d48e8e3ba92132b6e4acb3e094921cd3973c778

@roivaz
Copy link
Member Author

roivaz commented Jul 30, 2021

/approve

@3scale-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: roivaz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@3scale-robot 3scale-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 30, 2021
@3scale-robot 3scale-robot merged commit b1daaba into main Jul 30, 2021
@3scale-robot 3scale-robot deleted the doc/v0.8.0 branch July 30, 2021 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@slopezz slopezz slopezz left review comments

@raelga raelga raelga approved these changes

Assignees

@raelga raelga

@roivaz roivaz

@slopezz slopezz

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next sprint. size/L Requires few days to complete the PR or the issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@roivaz @slopezz @3scale-robot @raelga