Skip to content

Instantly share code, notes, and snippets.

@derberg
Last active April 3, 2019 10:48
Show Gist options
  • Save derberg/200ff22ea05249da93894ecc721ffd29 to your computer and use it in GitHub Desktop.
Save derberg/200ff22ea05249da93894ecc721ffd29 to your computer and use it in GitHub Desktop.
examples of docstopics

service catalog like example

apiVersion: cms.kyma-project.io/v1alpha1
kind: DocsTopic
metadata:
  name: slack
  labels:
    cms.kyma-project.io/view-context: service-catalog
spec:
  displayName: Slack
  description: "Slack documentation"
  sources:
    - type: markdown
      name: markdown-doc
      mode: single
      url: https://raw.githubusercontent.com/slackapi/slack-api-specs/master/README.md
    - type: asyncapi
      name: events-api
      mode: single
      url: https://raw.githubusercontent.com/slackapi/slack-api-specs/master/events-api/slack_events_api_async_v1.json
    - type: openapi
      name: openapi-swagger
      mode: single
      url: https://raw.githubusercontent.com/slackapi/slack-api-specs/master/web-api/slack_web_openapi_v2.json

docs ui like example

apiVersion: cms.kyma-project.io/v1alpha1
kind: ClusterDocsTopic
metadata:
  name: kubernetes-workloads
  labels:
    cms.kyma-project.io/view-context: docs-ui
    cms.kyma-project.io/order: "1"
    cms.kyma-project.io/group-name: Kubernetes
spec:
  displayName: "Workloads"
  description: "These are official Kubernetes docs about workloads"
  sources:
   - type: markdown
     name: markdown-files
     mode: package
     url: https://github.com/kubernetes/website/archive/master.zip
     filter: /content/en/docs/concepts/workloads/controllers
   - type: markdown
     name: markdown-files
     mode: package
     url: https://github.com/kubernetes/website/archive/master.zip
     filter: /content/en/docs/concepts/workloads/pods
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment