Merge pull request #300 from hookdeck/chore/doc-updates

chore(docs): update for release

Author: leggetter

README.md

@@ -183,7 +183,7 @@ Continue to use the [Outpost API](https://outpost.hookdeck.com/docs/references/a
 - [Get Started](https://outpost.hookdeck.com/docs/quickstarts)
 - [Overview](https://outpost.hookdeck.com/docs/overview)
 - [Features](https://outpost.hookdeck.com/docs/features)
-- [Guides](https://outpost.hookdeck.com/docs/guides/deployment)
+- [Guides](https://outpost.hookdeck.com/docs/guides)
 - References
     - [API Reference](https://outpost.hookdeck.com/docs/references/api)
     - [Configuration Reference](https://outpost.hookdeck.com/docs/references/configuration)

docs/pages/concepts.mdx

@@ -27,18 +27,32 @@ Outpost is deployed with three services:
 - Redis 6.0+ or wire-compatible alternative (RBD or AOF strongly recommended)
 - One of the supported message queues:
   - AWS SQS
-  - GCP Pubsub
-  - Azure Service Bus
   - RabbitMQ
+  - [GCP Pub/Sub (planned)](https://github.com/hookdeck/outpost/issues/138)
+  - [Azure EventBus (planned)](https://github.com/hookdeck/outpost/issues/139)
 
 ### Log Service
 
+Required for log storage.
+
 - PostgreSQL
+- [ClickHouse (planned)](https://github.com/hookdeck/outpost/issues/52)
+
+## Tenant Destination Types
+
+Event destination types that belong to Outpost tenants and where events are delivered to.
+
+- **Webhooks**
+- **RabbitMQ**
+- **AWS SQS**
+- **[Hookdeck Event Gateway (planned)](https://github.com/hookdeck/outpost/issues/136)**
+- **[Amazon EventBridge (planned)](https://github.com/hookdeck/outpost/issues/201)**
+- **[Azure EventBus (planned)](https://github.com/hookdeck/outpost/issues/241)**
+- **[GCP Pub/Sub (planned)](https://github.com/hookdeck/outpost/issues/140)**
+- **[Kafka (planned)](https://github.com/hookdeck/outpost/issues/141)**
 
-<details>
-  <summary>Future Roadmap</summary>- Clickhouse
-</details>
+If there is an event destination type that you would like to see supported, [open a feature request](https://github.com/hookdeck/outpost/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%F0%9F%9A%80+Feature%3A+).
 
 ## Benchmarks
 
-Coming soon...
+([Planned](https://github.com/hookdeck/outpost/issues/204))

docs/pages/guides.mdx

@@ -0,0 +1,22 @@
+---
+title: Outpost Guides
+---
+
+Welcome to the Outpost guides section. These guides will help you get the most out of Outpost for your event destinations journey.
+
+## Setup & Installation
+
+- [Deployment](/guides/deployment)
+
+## Integration Guides
+
+- [Publish from RabbitMQ](/guides/publish-from-rabbitmq)
+- [Publish from SQS](/guides/publish-from-sqs)
+
+## Migration Guides
+
+- [Migrate Existing Webhooks to Outpost](/guides/migrate-to-outpost)
+
+## Next Steps
+
+Looking for a specific guide that's not listed here? Please consider [opening a feature request](https://github.com/hookdeck/outpost/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%F0%9F%9A%80+Feature%3A+) to let us know what documentation would be helpful.

docs/pages/guides/publish-from-rabbitmq.mdx

@@ -13,7 +13,7 @@ RabbitMQ messages should have the same payload structure as the [Publish API end
   "tenant_id": "<TENANT_ID>",
   "destination_id": "<DESTINATION_ID>", // Optional. Provide a way of routing events to a specific destination
   "topic": "topic.name", // Topic defined in TOPICS environment variable
-  "eligible_for_retry": true | false, // Should event delivery be retried
+  "eligible_for_retry": false | true, // Should event delivery be retried. Default is false.
   "metadata": Payload, // can by any JSON payload,
   "data": Payload // can by any JSON payload
 }

docs/pages/guides/publish-from-sqs.mdx

@@ -13,7 +13,7 @@ SQS messages should have the same payload structure as the [Publish API endpoint
   "tenant_id": "<TENANT_ID>",
   "destination_id": "<DESTINATION_ID>", // Optional. Provide a way of routing events to a specific destination
   "topic": "topic.name", // Topic defined in TOPICS environment variable
-  "eligible_for_retry": true | false, // Should event delivery be retried
+  "eligible_for_retry": false | true, // Should event delivery be retried. Default is false.
   "metadata": Payload, // can by any JSON payload,
   "data": Payload // can by any JSON payload
 }

docs/pages/references/roadmap.mdx

@@ -11,8 +11,8 @@ title: "Outpost Roadmap"
 - ✅ Event ingestion: Publish API & PublishMQ
 - ✅ Event delivery
 - ✅ Log (events & attempts) persistence logic
-- 🚧 [PostgreSQL log storage](https://github.com/hookdeck/outpost/issues/205)
-- 🚧 [User Portal](https://github.com/hookdeck/outpost/issues/107)
+- ✅ [PostgreSQL log storage](https://github.com/hookdeck/outpost/issues/205)
+- ✅ [User Portal v0.1](https://github.com/hookdeck/outpost/issues/107)
 
 See Outpost [Concepts](/docs/concepts) and [Features](/docs/features) for more information.
 
@@ -31,7 +31,9 @@ See Outpost [Concepts](/docs/concepts) and [Features](/docs/features) for more i
 
 ## Core Functionality
 
+- ❌ [Postgres partition management](https://github.com/hookdeck/outpost/issues/249)
 - 🚧 [Clickhouse log storage](https://github.com/hookdeck/outpost/issues/52)
+- ❌ [User Portal v0.2](https://github.com/hookdeck/outpost/issues/299)
 
 ### Publish Message Queues
 

docs/public/images/outpost-schema.png

@@ -32,7 +32,6 @@ const config: ZudokuConfig = {
   // },
   redirects: [
     { from: "/", to: "/overview" },
-    { from: "/guides", to: "/guides/deployment" },
     { from: "/references", to: "/references/api" },
   ],
   plugins: [htmlPlugin({ headScript: ZUDOKU_PUBLIC_CUSTOM_HEAD_SCRIPT })],
@@ -100,6 +99,7 @@ const config: ZudokuConfig = {
         label: "Guides",
         collapsed: false,
         collapsible: false,
+        link: "guides",
         items: [
           {
             type: "doc",

docs/zudoku.config.ts

@@ -33,17 +33,20 @@ class OutpostClient {
   async publishEvent({
     tenant_id,
     topic,
+    eligible_for_retry,
     data,
     metadata,
   }: {
     tenant_id: string;
     topic: string;
+    eligible_for_retry: boolean;
     data: any;
     metadata: any;
   }): Promise<boolean> {
     const response = await this.request("/publish", "POST", {
       tenant_id,
       topic,
+      eligible_for_retry,
       data,
       metadata,
     });

examples/demos/nodejs/src/lib/outpost-client.ts

@@ -12,6 +12,7 @@ const main = async () => {
       const event = {
         tenant_id: organization.id,
         topic: destination.topics[0],
+        eligible_for_retry: true,
         data: {
           test: "data",
           from_organization_id: organization.id,