From a747f41bb99b7a01af88813c04d4daffdb0fe9b0 Mon Sep 17 00:00:00 2001 From: mertkahyaoglu Date: Sun, 24 Sep 2017 12:38:40 +0300 Subject: [PATCH] update docs --- docs/architecture.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index 8f84dbde7..2d386d459 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -8,8 +8,6 @@ description: Jekyll Admin exists in two parts, a Ruby back end and a Javascript Jekyll Admin piggybacks on Jekyll's built-in Webrick server. We monkey patch the `jekyll serve` command to hook in two Sinatra servers, one to serve the static front end that lives in `lib/jekyll-admin/public/dist` via `/admin`, and one to serve the Ruby API via `/_api`. Once the Sinatra servers are mounted, they work just like any other Jekyll server (and we rely on third-party plugins like `sintra-json` and `sinatra-cross_origin`). -**Note:** Since there are two Sinatra servers that might call `site.process` concurrently, Jekyll Admin disables `--watch` flag to prevent a race condition between these servers that might cause incorrect responses for the API. This ensures that the site is regenerated by only the process that Jekyll Admin runs. - ## How Jekyll Admin formats Jekyll objects for the API Whenever possible, we want to stay as close to the `to_liquid.to_json` representation of Jekyll's internal object structure as possible, so that we're (A) using data structure that developers are used to, and (B) so that we can benefit from upstream improvements. To do this, we have the `JekyllAdmin::APIable` module, which gets included in native Jekyll objects like Pages and Documents to add a `to_api` method which we can call to generate hashes for use in the API.