ORY's Documentation Template Repository

DEPRECATED

This repository is no longer used. All documentation now resides in github.com/ory/docs.

Initialize Documentation

To create a new documentation for a new or existing project, copy the contents (without node_modules) into the project's ./docs directory. Next you need to create these files (relative to the project's root directory) directory:

// ./docs/config.js
//
// This file contains the project's name and slug and tag line, for example:
module.exports = {
  projectName: 'ORY Keto',
  projectSlug: 'keto',
  projectTagLine:
    'A cloud native access control server providing best-practice patterns (RBAC, ABAC, ACL, AWS IAM Policies, Kubernetes Roles, ...) via REST APIs.',
  updateTags: [
    {
      image: 'oryd/keto',
      files: ['docs/docs/configure-deploy.md']
    }
  ],
  updateConfig: {
    src: '.schema/config.schema.json',
    dst: './docs/docs/reference/configuration.md'
  }
}

// ./docs/sidebar.js
//
// This represents the sidebar navigation, for example:
module.exports = {
  Introduction: ['index', 'install']
}

// ./docs/src/css/theme.css
// empty file is ok

// ./docs/versions.json
// empty object is ok
{
}

Adding Documentation

Next, put your markdown files in ./docs/docs. You may also want to add the CircleCI Orb ory/docs to your CI config, depending on the project type.

Update Documentation

This is usually done automatically in CI and will create PRs in the respective projects.

Check out docusaurus-template using git clone [email protected]:ory/docusaurus-template.git docusaurus-template. It is important that the directory is named docusaurus-template!

Then, make your changes, and run ./update.sh.