Skip to content

Commit

Permalink
docs: update github templates
Browse files Browse the repository at this point in the history
Signed-off-by: aeneasr <aeneas@ory.sh>
  • Loading branch information
aeneasr committed Apr 13, 2020
1 parent e4e74b1 commit a07e83e
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 35 deletions.
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -1,7 +1,6 @@
---
name: Bug report
about: Create a report to help us improve

---

**Describe the bug**
Expand All @@ -18,15 +17,15 @@ Steps to reproduce the behavior:
3. Request fails with response: `{"some": "error"}`
-->

*Server logs*
_Server logs_

<!--
```
log=error ....
```
-->

*Server configuration*
_Server configuration_

<!--
PLEASE OMIT SENSITIVE VALUES
Expand All @@ -44,8 +43,8 @@ A clear and concise description of what you expected to happen.

**Environment**

* Version: v1.2.3, git sha hash
* Environment: Debian, Docker, ...
- Version: v1.2.3, git sha hash
- Environment: Debian, Docker, ...

**Additional context**

Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -1,22 +1,22 @@
---
name: Feature request
about: Suggest an idea for this project

---

**Is your feature request related to a problem? Please describe.**

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
A clear and concise description of what the problem is. Ex. I'm always
frustrated when [...]

**Describe the solution you'd like**

A clear and concise description of what you want to happen.

**Describe alternatives you've considered**

A clear and concise description of any alternative solutions or features you've considered.
A clear and concise description of any alternative solutions or features you've
considered.

**Additional context**

Add any other context or screenshots about the feature request here.

10 changes: 6 additions & 4 deletions .github/ISSUE_TEMPLATE/support.md
@@ -1,8 +1,10 @@
---
name: Support request
about: Please use our forums (community.ory.sh) or the chat (ory.sh/chat) to ask for support

about:
Please use our forums (community.ory.sh) or the chat (ory.sh/chat) to ask for
support
---

Please use issues only to file potential bugs or request features. For everything else please go to
the [ORY Community](https://community.ory.sh/) or join the [ORY Chat](https://www.ory.sh/chat).
Please use issues only to file potential bugs or request features. For
everything else please go to the [ORY Community](https://community.ory.sh/) or
join the [ORY Chat](https://www.ory.sh/chat).
10 changes: 7 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -26,9 +26,13 @@ them, don't hesitate to ask. We're here to help! This is simply a reminder of wh

- [ ] I have read the [contributing guidelines](../blob/master/CONTRIBUTING.md).
- [ ] I have read the [security policy](../security/policy).
- [ ] I confirm that this pull request does not address a security vulnerability. If this pull request addresses a security.
vulnerability, I confirm that I got green light (please contact [security@ory.sh](mailto:security@ory.sh)) from the maintainers to push the changes.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] I confirm that this pull request does not address a security
vulnerability. If this pull request addresses a security. vulnerability, I
confirm that I got green light (please contact
[security@ory.sh](mailto:security@ory.sh)) from the maintainers to push
the changes.
- [ ] I have added tests that prove my fix is effective or that my feature
works.
- [ ] I have added or changed [the documentation](docs/docs).

## Further comments
Expand Down
16 changes: 9 additions & 7 deletions CONTRIBUTING.md
Expand Up @@ -56,22 +56,24 @@ should be merged by the submitter after review.

## Disclosing vulnerabilities

Please disclose vulnerabilities exclusively to [security@ory.sh](mailto:security@ory.sh). Do
not use GitHub issues.
Please disclose vulnerabilities exclusively to
[security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues.

## Code Style

Please follow these guidelines when formatting source code:

- Go code should match the output of `gofmt -s` and pass `golangci-lint run`.
- NodeJS and JavaScript code should be prettified using `npm run format` where appropriate.
- NodeJS and JavaScript code should be prettified using `npm run format` where
appropriate.

## Documentation

Please provide documentation when changing, removing, or adding features. Documentation
resides in the project's [docs](docs) folder. Some documents are generated using `npm run gen`.
Please provide documentation when changing, removing, or adding features.
Documentation resides in the project's [docs](docs) folder. Generate API and
configuration reference documentation using `cd docs; npm run gen`.

More information on the docs pipeline can be found in [docs/README.md](docs/README.md).
For further instructions please head over to [docs/README.md](docs/README.md).

## Pull request procedure

Expand Down Expand Up @@ -99,7 +101,7 @@ please include a note in your commit message explaining why.

## Communication

We use [discord](https://www.ory.sh/chat). You are welcome to drop in and ask
We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask
questions, discuss bugs, etc.

## Conduct
Expand Down
29 changes: 18 additions & 11 deletions README.md
Expand Up @@ -191,19 +191,24 @@ TheCrealm.




## Ecosystem

<!--BEGIN ECOSYSTEM-->
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

Expand All @@ -216,25 +221,26 @@ 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

[ORY Keto](https://github.com/ory/keto) is a policy decision point. It uses a
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.

<!--END ECOSYSTEM-->


Expand All @@ -243,6 +249,7 @@ to perform a certain action on a resource.




## Security

### Disclosing vulnerabilities
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
@@ -1,6 +1,6 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*


- [Security Policy](#security-policy)
- [Supported Versions](#supported-versions)
Expand Down

0 comments on commit a07e83e

Please sign in to comment.