From 2f88e7e1d110b54e458729edae585c8c8fcf271d Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Mon, 12 Aug 2019 12:37:39 +0200 Subject: [PATCH] fix(core): update --- markdown/index.md | 19 +++++++++++++++---- markdown/nodejs.md | 3 +++ markdown/sdks/nodejs.md | 4 ---- markdown/support.md | 3 +++ mkdocs.yml | 14 +++++++------- 5 files changed, 28 insertions(+), 15 deletions(-) create mode 100644 markdown/nodejs.md delete mode 100644 markdown/sdks/nodejs.md create mode 100644 markdown/support.md diff --git a/markdown/index.md b/markdown/index.md index 301badf..10c0a0d 100644 --- a/markdown/index.md +++ b/markdown/index.md @@ -1,8 +1,19 @@ -# Bellini.io Documentation -headless Open Source CMS +# Getting started with api.global + +!!! info + Use the search box for quickly finding what you are looking for. ## What is this? -bellini.io enables easy maintance of content for large scale commercial websites. +api.global is the high availability api endpoint for all products created by [lossless](https://lossless.com). + +!!! hint + Most products offer TypeScript packages on npm that simplify interaction with the API for the product specific use case. As of now those are: + + * [@layer.io/api](https://npmjs.org/layer.io/api) + * [@social.io/api](https://npmjs.org/layer.io/api) + * [@onboardme/api](https://npmjs.org/layer.io/api) + * [@inwork/api](https://npmjs.org/layer.io/api) ## What does this documentation cover? -This documentation explains how to interface with bellini.io and how to use its APIs +This documentation explains how to structure api calls to api.global and to be aware of the mechanics of load distribution. +We strongly recommend checking out our npm package that implements the hard stuff for you. diff --git a/markdown/nodejs.md b/markdown/nodejs.md new file mode 100644 index 0000000..217c9e1 --- /dev/null +++ b/markdown/nodejs.md @@ -0,0 +1,3 @@ +# NodeJS SDK + +api.global offers a nodejs sdk that makes it easy to implement api.global features into your own software diff --git a/markdown/sdks/nodejs.md b/markdown/sdks/nodejs.md deleted file mode 100644 index 00da143..0000000 --- a/markdown/sdks/nodejs.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -name: NodeJS SDK ---- -bellini.io offers a TypeScript package which is the recommended way of interfacing with bellini.io diff --git a/markdown/support.md b/markdown/support.md new file mode 100644 index 0000000..b8d1a34 --- /dev/null +++ b/markdown/support.md @@ -0,0 +1,3 @@ +# Support + +api.global is covered by Lossless Support. To see available support packages visit https://lossless.support \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index f8f1074..fb8c921 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ # Project information -site_name: api.global - high availability API +site_name: api.global - documentation site_description: high availability API made by lossless site_author: Lossless GmbH site_url: https://docs.api.global/ @@ -10,8 +10,8 @@ site_dir: public # Repository repo_name: apiglobal/docs -repo_url: https://gitlab.com/apiglobal/docs -edit_uri: "https://gitlab.com/apiglobal/docs/edit/master/markdown/" +repo_url: +edit_uri: "" # Copyright copyright: 'Copyright © 2016 - 2019 Lossless GmbH' @@ -86,7 +86,7 @@ markdown_extensions: # Page tree nav: - - Getting Started: index.md - - API: - - REST: api.md - - NodeJS: sdks/nodejs.md + - Overview: + - Getting Started: index.md + - NodeJS: nodejs.md + - Support: support.md