Merged
Conversation
- Remove duplicated content from README that already exists in CONTRIBUTING.md (testing, setup, pre-commit, security scanning, documentation templates) - Remove feature/resource lists and extra examples that require constant updating when resources change - Keep README focused: installation, authentication, quick start - Fix Quick Start example: add missing required provider_type field on ory_social_provider, use normalized duration format (720h0m0s) - Point users to Terraform Registry docs and examples/ for full resource documentation - Add missing "Reporting Vulnerabilities" section to SECURITY.md - Remove incorrect supported version table (listed 0.1.x, latest is v0.0.5)
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-focused update to reduce ongoing README maintenance burden and correct the repository’s security policy guidance for vulnerability reporting.
Changes:
- Simplified
README.mdby removing large, frequently-changing feature/resource listings and pointing readers to Terraform Registry docs andexamples/. - Updated README Quick Start snippets to include required
provider_typeforory_social_providerand normalized duration formatting (720h0m0s). - Reworked
SECURITY.mdby removing an incorrect supported-versions table and adding explicit vulnerability reporting instructions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| SECURITY.md | Removes incorrect supported-versions content and adds a clear vulnerability reporting process. |
| README.md | Streamlines documentation, fixes Quick Start examples, and points users to canonical docs/examples to reduce maintenance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
KT-Doan
requested review from
Demonsthere,
adamwalach,
lovelinuxalot,
nipsufn and
ryderdain
lovelinuxalot
approved these changes
Mar 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Slim down README to avoid constant maintenance when resources are added/changed. Fix SECURITY.md to include vulnerability reporting instructions and remove incorrect version table.
Related Issues
N/A
Type of Change
Checklist
make test)make format)Testing
N/A — documentation-only changes.
Screenshots/Output
README changes
provider_typeonory_social_provider, normalized duration format (720h0m0s)examples/for full resource documentationSECURITY.md changes
0.1.x(latest release isv0.0.5)