From 08a6e8d8917735ede63f8c4dce3414f471111564 Mon Sep 17 00:00:00 2001 From: aeneasr Date: Mon, 13 Apr 2020 09:21:06 +0200 Subject: [PATCH] docs: update github templates Signed-off-by: aeneasr --- .github/ISSUE_TEMPLATE/bug_report.md | 9 ++++--- .github/ISSUE_TEMPLATE/feature_request.md | 8 +++---- .github/ISSUE_TEMPLATE/support.md | 10 ++++---- .github/PULL_REQUEST_TEMPLATE.md | 10 +++++--- CONTRIBUTING.md | 16 +++++++------ README.md | 29 ++++++++++++++--------- SECURITY.md | 2 +- 7 files changed, 49 insertions(+), 35 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a7e8cbae6..0593c86a9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,6 @@ --- name: Bug report about: Create a report to help us improve - --- **Describe the bug** @@ -18,7 +17,7 @@ Steps to reproduce the behavior: 3. Request fails with response: `{"some": "error"}` --> -*Server logs* +_Server logs_ -*Server configuration* +_Server configuration_ -We build Ory on several guiding principles when it comes to our architecture design: + +We build Ory on several guiding principles when it comes to our architecture +design: - Minimal dependencies - Runs everywhere - Scales without effort - Minimize room for human and network errors -ORY's architecture designed to run best on a Container Orchestration Systems such as Kubernetes, CloudFoundry, OpenShift, and similar projects. -Binaries are small (5-15MB) and available for all popular processor types (ARM, AMD64, i386) and operating -systems (FreeBSD, Linux, macOS, Windows) without system dependencies (Java, Node, Ruby, libxml, ...). +ORY's architecture designed to run best on a Container Orchestration Systems +such as Kubernetes, CloudFoundry, OpenShift, and similar projects. Binaries are +small (5-15MB) and available for all popular processor types (ARM, AMD64, i386) +and operating systems (FreeBSD, Linux, macOS, Windows) without system +dependencies (Java, Node, Ruby, libxml, ...). ### ORY Kratos: Identity and User Infrastructure and Management @@ -211,18 +216,18 @@ deal with: Self-service Login and Registration, Multi-Factor Authentication ### ORY Hydra: OAuth2 & OpenID Connect Server -[ORY Hydra](https://github.com/ory/hydra) is an OpenID Certified™ OAuth2 and OpenID Connect -Provider can connect to any existing identity database (LDAP, AD, KeyCloak, PHP+MySQL, ...) -and user interface. +[ORY Hydra](https://github.com/ory/hydra) is an OpenID Certified™ OAuth2 and +OpenID Connect Provider can connect to any existing identity database (LDAP, AD, +KeyCloak, PHP+MySQL, ...) and user interface. ### ORY Oathkeeper: Identity & Access Proxy [ORY Oathkeeper](https://github.com/ory/oathkeeper) is a BeyondCorp/Zero Trust Identity & Access Proxy (IAP) with configurable authentication, authorization, -and request mutation rules for your web services: Authenticate JWT, Access Tokens, -API Keys, mTLS; Check if the contained subject is allowed to perform the request; -Encode resulting content into custom headers (`X-User-ID`), JSON Web Tokens -and more! +and request mutation rules for your web services: Authenticate JWT, Access +Tokens, API Keys, mTLS; Check if the contained subject is allowed to perform the +request; Encode resulting content into custom headers (`X-User-ID`), JSON Web +Tokens and more! ### ORY Keto: Access Control Policies as a Server @@ -230,6 +235,7 @@ and more! set of access control policies, similar to AWS IAM Policies, in order to determine whether a subject (user, application, service, car, ...) is authorized to perform a certain action on a resource. + @@ -238,6 +244,7 @@ to perform a certain action on a resource. + ### Examples The [ory/examples](https://github.com/ory/examples) repository contains numerous examples of setting up this project and combining it with other services from the ORY Ecosystem. diff --git a/SECURITY.md b/SECURITY.md index d65c31cda..d29b5e63a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,6 +1,6 @@ -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + - [Security Policy](#security-policy) - [Supported Versions](#supported-versions)