Skip to content

Commit

Permalink
Improvement/Bring docs into monorepo (#2126)
Browse files Browse the repository at this point in the history
* Bring docs into mono repo

Added github action to check docs fot bad links

Lint

Fix action

Node version

Revert ugh

improvement/bring docs into monorepo

Rename job

* Enterprise plan for OpenShift

* Update docs/docusaurus.config.js

Co-authored-by: Kim Gustyr <kim.gustyr@flagsmith.com>

* Remove expected 500 error from docs

* Removed redundant branch logic

---------

Co-authored-by: Kim Gustyr <kim.gustyr@flagsmith.com>
Co-authored-by: Matthew Elwell <matthew.elwell@flagsmith.com>
  • Loading branch information
3 people committed Apr 24, 2023
1 parent 9c18ead commit 9a28ee2
Show file tree
Hide file tree
Showing 303 changed files with 43,487 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/docs-pull-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Docs Lint/Link Checks

on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
paths:
- docs/**
- .github/**

defaults:
run:
working-directory: docs

jobs:
checks:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Use Node.js 18
uses: actions/setup-node@v3
with:
node-version: 18
cache: 'npm'
cache-dependency-path: 'docs/package-lock.json'

- name: npm install
run: npm ci --include=dev --ignore-scripts
- name: Run docusuarus build to check for broken links etc
run: |
npx prettier --check docs
npm run build
50 changes: 50 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# OSX
#
.DS_Store

# Xcode
#
build/
*.pbxuser
!default.pbxuser
*.mode1v3
!default.mode1v3
*.mode2v3
!default.mode2v3
*.perspectivev3
!default.perspectivev3
xcuserdata
*.xccheckout
*.moved-aside
DerivedData
*.hmap
*.ipa
*.xcuserstate
project.xcworkspace

# Android/IJ
#
*.iml
.idea
.gradle
local.properties

# node.js
#
node_modules/
npm-debug.log

# BUCK
buck-out/
\.buckd/
android/app/libs
android/keystores/debug.keystore

site/

.envrc
.venv/
.direnv/

.docusaurus

1 change: 1 addition & 0 deletions docs/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v18.12.1
31 changes: 31 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Installation

```console
npm install
```

## Local Development

```console
npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without
having to restart the server.

## Build

```console
npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting
service.

## Deployment

This site is set to auto deploy to Vercel.
9 changes: 9 additions & 0 deletions docs/api_spec/Introduction.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"openapi": "3.0.3",
"info": {
"title": "Quick Start",
"version": "1",
"description": "[The Flagsmith Architecture](https://docs.flagsmith.com/deployment/overview#architecture) is based around a server-side flag engine. This comes with a number of benefits, but it can increase latency, especially when the calls are being made from a location that is far from the EU; the location of our current API. It also provides a single point of failure in the event of an AWS region-wide outage.\n\nThe Edge API solves both of these issues. It provides a datastore and Edge compute API that is replicated across 8 AWS regions, with latency-based routing and global failover in the event of a region outage.\n\n\n Our core Rules Engine has been factored out of our REST API. This allows us to use it as a dependency within both the Flagsmith API, but also within a set of Lambda functions that service SDK API calls. You can point your SDK clients to our global CDN `edge.api.flagsmith.com` which will serve your request using a Lambda function running in an AWS data-centre near your client. This is how we reduce latency!\n\n\n:::info INFO\nThe Edge API is only available with on our SaaS platform. It does not form part of our Open Source project.\n\n:::\n\n## Enabling the Edge API\n\n Once you have had your Projects migrated to Edge, all you will need to do is point your SDK to a new Flagsmith Edge API URL at `edge.api.flagsmith.com`. This domain points to our Edge CDN. That's it!\n\nThe easiest way to do this is to upgrade to the latest version of the Flagsmith SDK for your language.\n\n\n Find more information about the [Edge API](https://docs.flagsmith.com/advanced-use/edge-api).\n\n## Flagsmith REST API\n\n\nBefore running the application, you'll need to configure a database for the application. The steps to do this can be found in the following section entitled 'Databases'.\n\n Find more information about the [Flagsmith REST API](https://docs.flagsmith.com/deployment/hosting/locally-api)."
},
"paths": {}
}
Loading

0 comments on commit 9a28ee2

Please sign in to comment.