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

Add Routing Traffic to Your Application Guide #991

Merged
merged 23 commits into from
Aug 28, 2023

Conversation

kate-osborn
Copy link
Contributor

@kate-osborn kate-osborn commented Aug 18, 2023

Proposed changes

Problem: As a potential user of NKG, I want a guide to help me understand how to host an application API with NKG so that I can easily understand how to start using NKG in my environment immediately.

Solution: Add a use case guide that describes how to route all traffic to a single application running in Kubernetes using NKG.

Testing: Ran through guide

This is meant to be the basic use case guide so we are intentionally not introducing every field and variation of the Gateway API. We want to give the users enough information to get started. Other use case guides will build on the information provided in this guide.

Closes #876

The diagrams are written using mermaid, but the GitHub mermaid integration is not working well with dark mode, so I added them as pngs. The mermaid source files are in the /docs/images/source directory. This will allow internal and external contributors to easily modify the diagrams.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 18, 2023
docs/guides/directing-traffic-to-your-app.md Outdated Show resolved Hide resolved
docs/guides/directing-traffic-to-your-app.md Outdated Show resolved Hide resolved
docs/guides/directing-traffic-to-your-app.md Outdated Show resolved Hide resolved
docs/guides/directing-traffic-to-your-app.md Outdated Show resolved Hide resolved
docs/guides/directing-traffic-to-your-app.md Outdated Show resolved Hide resolved
docs/guides/directing-traffic-to-your-app.md Outdated Show resolved Hide resolved
docs/guides/directing-traffic-to-your-app.md Outdated Show resolved Hide resolved
docs/guides/directing-traffic-to-your-app.md Outdated Show resolved Hide resolved
docs/guides/directing-traffic-to-your-app.md Outdated Show resolved Hide resolved
docs/guides/directing-traffic-to-your-app.md Outdated Show resolved Hide resolved
@pleshakov pleshakov mentioned this pull request Aug 21, 2023
6 tasks
@mpstefan mpstefan marked this pull request as ready for review August 22, 2023 17:39
@mpstefan mpstefan requested a review from a team as a code owner August 22, 2023 17:39
Copy link
Collaborator

@mpstefan mpstefan left a comment

Choose a reason for hiding this comment

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

Paired with Kate on this. Added comments to other input.

Copy link
Member

@ciarams87 ciarams87 left a comment

Choose a reason for hiding this comment

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

LGTM! 🎉

@kate-osborn kate-osborn force-pushed the docs/basic-use-case-guide branch 2 times, most recently from 2c813b9 to 6d406ee Compare August 25, 2023 00:16
@kate-osborn kate-osborn changed the title Add use case guide for directing all traffic to an app Add Routing Traffic to Your Application Guide Aug 25, 2023
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

👍

docs/guides/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

LGTM, just two small suggestions.

.gitignore Show resolved Hide resolved
docs/guides/README.md Outdated Show resolved Hide resolved
@kate-osborn kate-osborn merged commit 1fafb5e into nginxinc:main Aug 28, 2023
22 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
Status: Done
Development

Successfully merging this pull request may close these issues.

Use Case Guide: How to direct traffic to your application via NKG
6 participants