This repository contains meta-documentation for the
ORY Ecosystem.
You can find the source files for each projects documentation here:
Other Ory Projects documentation:
Documentation for
the Ory Ecosystem lives in
ory/docs.
Documentation for the individual projects live in their respective docs
folder. (Ory Hydra,
Ory Kratos,
Ory Oathkeeper,
Ory Keto)
If you make changes, please consider making the same changes in the lastest
version of /versioned_docs
To test the documentation locally:
Change into the /docs folder in your local git environment.
Install dependencies npm install Test build the documentation:
npm start # test if everything works
To build the docs:
npm run build
Ory Documentations is structured into several main categories.
Each of those categories serves a specific purpose.
The purpose of each category is outline in short here, to help find the correct category for your documentation to live in.
- Introduction
- The purpose of this category is to introduce the very
basicsof the project and give newcomers a easy way to start. Contains the most basic explanation of the project, an installation guide, a Quickstart/5-Minute Tutorial and Contribution Guidelines.
- The purpose of this category is to introduce the very
- Concepts
- The purpose of this category is to give the reader a deep
understandingof the ideas upon which the project is built. Content in this category has the form of a discursive explanation. The main goal is toexplain.
- The purpose of this category is to give the reader a deep
- Guides
- The purpose of this category is to solve a specific problem. It has the form of a
series of stepstowards a goal. It is aimed towards more experienced users, who are already familiar with the concepts and tools.
- The purpose of this category is to solve a specific problem. It has the form of a
- Reference
- The purpose of this category is to provide detailed & in-depth description of the project . It has the form of a
austere and to the point explanationand is rooted in code, most often these documents are built directly from code without editor interaction. It does not give information on how to do specific things, but describes how to correctly use the APIs ect.
- The purpose of this category is to provide detailed & in-depth description of the project . It has the form of a
- SDK
- Same as the above category but for SDKs, also containing simple guides for using SDKs.
Add a meaningful title and an ID to the top of the document.
id needs to be separated with - and lowercase, title with space and Uppercase.
Example:
---
id: documentation-id
title: Documentation Title
---
If you would add a link to an outside ressource, just go ahead.
If you want to add a link to a document in our own documentation, please make sure to add the filename.
For example [XY Guide](./guide/XY.md) rather than [XY Guide](./guide/XY).
This prevents broken links (issue) when you load the documentation from an outside link.
Use CodeFromRemote to import code directly from Github.
Import at the beginning of your document like so:
---
id: documentation id
title: Documentation Title
---
import CodeFromRemote from '@theme/CodeFromRemote'
Then at the place you want the code to appear in the document add:
<CodeFromRemote src="https://github.com/$OWNER/$REPO/blob/$BRANCHNAME/path/to/your.file" />