Skip to content

Commit

Permalink
Update Troubleshooting guide (#2141)
Browse files Browse the repository at this point in the history
Problem: As a user, I want more detailed guide to troubleshoot if an error occurs with NGF

Solution: Updates existing troubleshooting with detailed overview
  • Loading branch information
salonichf5 authored Jul 9, 2024
1 parent 8884c70 commit 4980266
Show file tree
Hide file tree
Showing 2 changed files with 300 additions and 28 deletions.
2 changes: 1 addition & 1 deletion docs/developer/implementing-a-feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ practices to ensure a successful feature development process.
the [testing](/docs/developer/testing.md#unit-test-guidelines) documentation.
9. **Manually verify your changes**: Refer to the [manual testing](/docs/developer/testing.md#manual-testing) section of
the testing documentation for instructions on how to manually test your changes.
10. **Update any relevant documentation**: See the [documentation](/docs/developer/documentation.md) guide for in-depth information about the workflow to update the docs and how we publish them.
10. **Update any relevant documentation**: See the [documentation](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/site/README.md) guide for in-depth information about the workflow to update the docs and how we publish them.
Here are some basic guidelines for updating documentation:
- **Gateway API Feature**: If you are implementing a Gateway API feature, make sure to update
the [Gateway API Compatibility](/site/content/concepts/gateway-api-compatibility.md) documentation.
Expand Down
Loading

0 comments on commit 4980266

Please sign in to comment.