Skip to content

Commit 9fdd271

Browse files
committed
integrating github + readme docs
1 parent 4f38e13 commit 9fdd271

File tree

4 files changed

+25
-121
lines changed

4 files changed

+25
-121
lines changed

docs/auth.md

Lines changed: 0 additions & 115 deletions
This file was deleted.

docs/getting-started.md renamed to docs/readme-sync/deploy-as-a-microservice/012 - quickstart-with-docker.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
1-
# Getting Started Guide
2-
3-
This is a brief guide showing how to run Agent locally via Docker and how to access some of the common API endpoints.
1+
---
2+
title: "Quickstart with Docker"
3+
excerpt: ""
4+
slug: "quickstart-with-docker"
5+
hidden: true
6+
metadata:
7+
title: "Agent Quickstart with Docker - Optimizely Full Stack"
8+
createdAt: "2020-05-21T20:35:58.387Z"
9+
updatedAt: "2020-07-14T20:51:52.458Z"
10+
---
11+
12+
This is a brief quickstart showing how to run Agent locally via Docker and how to access some of the common API endpoints.
413
If Docker is not installed then you can download it [here](https://docs.docker.com/install/).
514

615
## Running locally via Docker
@@ -57,4 +66,4 @@ resp = s.post(url = 'http://localhost:8080/v1/activate', params=params, json=pay
5766
print(resp.json())
5867
```
5968

60-
The activate API is a POST to signal to the caller that there are side-effects. Namely, activation results in a "decision" event sent to Optimizely analytics for the purpose of analyzing Feature Test results. A "decision" will NOT be sent if the feature is simply part of a rollout.
69+
The activate API is a POST to signal to the caller that there are side-effects. Namely, activation results in a "decision" event sent to Optimizely analytics for the purpose of analyzing Feature Test results. A "decision" will NOT be sent if the feature is simply part of a rollout.

docs/notifications.md renamed to docs/readme-sync/deploy-as-a-microservice/040 - configure-optimizely-agent/031 - agent-notifications.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1-
# Notifications Guide
1+
---
2+
title: Agent Notifications"
3+
excerpt: ""
4+
slug: "agent-notifications"
5+
hidden: false
6+
metadata:
7+
title: "Agent notifications - Optimizely Full Stack"
8+
createdAt: "2020-05-21T20:35:58.387Z"
9+
updatedAt: "2020-07-14T20:51:52.458Z"
10+
---
11+
212

313
Agent provides an endpoint that sends notifications to subscribers via [Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events). This is Agent's equivalent of Notification Listeners found in Optimizely SDKs.
414

docs/advanced-configuration.md renamed to docs/readme-sync/deploy-as-a-microservice/040 - configure-optimizely-agent/040 -advanced-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export OPTIMIZELY_CLIENT_POLLINGINTERVAL=120s
3131
```
3232

3333
## Unsupported Environment Variable Options
34-
Some options can only be set via config file, and not environment variable (for details on these options, see the Configuration Options table in the [main README](../README.md)):
34+
Some options can only be set via config file, and not environment variable (for details on these options, see the Configuration Options table in the [main README](https://github.com/optimizely/agent/blob/master/README.md):
3535
- `admin.auth.clients`
3636
- `api.auth.clients`
3737
- Options under`webhook.projects`

0 commit comments

Comments
 (0)