feat(docs): going public (#784)

Co-authored-by: Joshua Croft <[email protected]> Co-authored-by: gautamgambhir97 <[email protected]> Co-authored-by: gautamgambhir97 <[email protected]>
fetchai · Jul 15, 2024 · e94347c · e94347c
1 parent 603dfee
commit e94347c
Show file tree

Hide file tree

Showing 42 changed files with 95 additions and 2,006 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,6 @@
+BACKEND_URL=
+NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID=
+NEXT_PUBLIC_ALGOLIA_APP_ID=
+NEXT_PUBLIC_ALGOLIA_API_KEY=
+NEXT_PUBLIC_ALGOLIA_INDEX=
+NEWSLETTER_BASE_URL=
diff --git a/.env.local b/.env.local
diff --git a/.github/workflows/deploy-production.yml b/.github/workflows/deploy-production.yml
@@ -39,6 +39,10 @@ jobs:
         env:
           BACKEND_URL: ${{ secrets.NEXT_PUBLIC_BACKEND_URL }}
           NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID: ${{ secrets.NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID }}
+          NEXT_PUBLIC_ALGOLIA_APP_ID: ${{ secrets.NEXT_PUBLIC_ALGOLIA_APP_ID }}
+          NEXT_PUBLIC_ALGOLIA_API_KEY: ${{ secrets.NEXT_PUBLIC_ALGOLIA_API_KEY }}
+          NEXT_PUBLIC_ALGOLIA_INDEX: ${{ secrets.NEXT_PUBLIC_ALGOLIA_INDEX }}
+          NEWSLETTER_BASE_URL: ${{ secrets.NEWSLETTER_BASE_URL }}
           SENDER_TOKEN: ${{ secrets.SENDER_TOKEN }}
 
       - name: Trigger Image Update

diff --git a/.github/workflows/deploy-staging.yml b/.github/workflows/deploy-staging.yml
@@ -39,6 +39,10 @@ jobs:
         env:
           BACKEND_URL: ${{ secrets.STAGING_NEXT_PUBLIC_BACKEND_URL }}
           NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID: ${{ secrets.NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID }}
+          NEXT_PUBLIC_ALGOLIA_APP_ID: ${{ secrets.NEXT_PUBLIC_ALGOLIA_APP_ID }}
+          NEXT_PUBLIC_ALGOLIA_API_KEY: ${{ secrets.NEXT_PUBLIC_ALGOLIA_API_KEY }}
+          NEXT_PUBLIC_ALGOLIA_INDEX: ${{ secrets.NEXT_PUBLIC_ALGOLIA_INDEX }}
+          NEWSLETTER_BASE_URL: ${{ secrets.NEWSLETTER_BASE_URL }}
           SENDER_TOKEN: ${{ secrets.SENDER_TOKEN }}
 
   deploy:

diff --git a/.github/workflows/ephemeral-deploy.yaml b/.github/workflows/ephemeral-deploy.yaml
@@ -40,6 +40,10 @@ jobs:
         env:
           BACKEND_URL: ${{ secrets.STAGING_NEXT_PUBLIC_BACKEND_URL }}
           NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID: ${{ secrets.NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID }}
+          NEXT_PUBLIC_ALGOLIA_APP_ID: ${{ secrets.NEXT_PUBLIC_ALGOLIA_APP_ID }}
+          NEXT_PUBLIC_ALGOLIA_API_KEY: ${{ secrets.NEXT_PUBLIC_ALGOLIA_API_KEY }}
+          NEXT_PUBLIC_ALGOLIA_INDEX: ${{ secrets.NEXT_PUBLIC_ALGOLIA_INDEX }}
+          NEWSLETTER_BASE_URL: ${{ secrets.NEWSLETTER_BASE_URL }}
           SENDER_TOKEN: ${{ secrets.SENDER_TOKEN }}
 
   deploy:

diff --git a/Dockerfile b/Dockerfile
@@ -1,6 +1,11 @@
 FROM node:18-alpine
 
 ARG BACKEND_URL=""
+ARG NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID=""
+ARG NEXT_PUBLIC_ALGOLIA_APP_ID=""
+ARG NEXT_PUBLIC_ALGOLIA_API_KEY=""
+ARG NEXT_PUBLIC_ALGOLIA_INDEX=""
+ARG NEWSLETTER_BASE_URL=""
 ARG SENDER_TOKEN=""
 
 RUN apk add tree && corepack prepare [email protected] --activate && corepack enable
@@ -17,6 +22,10 @@ ENV NODE_ENV="production"
 RUN echo BACKEND_URL="${BACKEND_URL}" > .env.local && \
     echo SENDER_TOKEN="${SENDER_TOKEN}" > .env.local && \
     echo NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID="${NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID}" >> .env.local && \
+    echo NEXT_PUBLIC_ALGOLIA_APP_ID="${NEXT_PUBLIC_ALGOLIA_APP_ID}" >> .env.local && \
+    echo NEXT_PUBLIC_ALGOLIA_API_KEY="${NEXT_PUBLIC_ALGOLIA_API_KEY}" >> .env.local && \
+    echo NEXT_PUBLIC_ALGOLIA_INDEX="${NEXT_PUBLIC_ALGOLIA_INDEX}" >> .env.local && \
+    echo NEWSLETTER_BASE_URL="${NEWSLETTER_BASE_URL}" >> .env.local && \
     pnpm build
 
 ENTRYPOINT ["pnpm"]

diff --git a/README.md b/README.md
@@ -15,12 +15,6 @@ Select the appropriate route, and create a new file ending in `.mdx`. Then, upda
 }
 ```
 
-## Deployments
-
-### Staging Website
-
-https://docs-staging.sandbox-london-b.fetch-ai.com/docs
-
 ## Developing
 
 ### Install dependencies

diff --git a/components/account-menu.tsx b/components/account-menu.tsx
diff --git a/components/api-endpoint.tsx b/components/api-endpoint.tsx
@@ -9,10 +9,8 @@ import {
   Tab,
   DropDownTabs,
 } from "./mdx";
-import { useUserContext } from "theme/fetch-ai-docs/contexts/context-provider";
 import Tooltip from "./tooltip";
 import Link from "next/link";
-import fetchJson from "src/lib/fetch-json";
 
 interface PropertyType {
   name: string;
@@ -347,29 +345,27 @@ export const ApiEndpointRequestResponse: React.FC<{
     setIsModalOpen(false);
   };
 
-  const context = useUserContext();
-
-  const hitRequest = async () => {
+  const hitRequestWithoutLogin = async () => {
     try {
       setLoading(true);
       setError("");
       const requestPayloadJSON = JSON.parse(requestPayload || "{}");
       const apiUrlWithParams = (properties.apiUrl +
         replacePathParameters(properties.path, pathParameters)) as string;
-
-      const response: { data: unknown } = await fetchJson(
-        `/docs/api/api-requests?url=${apiUrlWithParams}`,
-        {
-          method: properties.method,
-          body: properties.method.includes("GET") ? null : requestPayloadJSON,
+      const response = await fetch(apiUrlWithParams, {
+        method: properties.method,
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${bearerToken}`,
         },
-      );
-      const responseText = JSON.stringify(response.data, null, 2);
+        body: properties.method.includes("GET")
+          ? null
+          : JSON.stringify(requestPayloadJSON),
+      });
+      const data = await response.json();
+      const responseText = JSON.stringify(data, null, 2);
       setActualResponse(responseText);
     } catch (error) {
-      if (error.response.status === 422) {
-        context.signOut();
-      }
       setError(`Error: ${error.message}`);
     } finally {
       setLoading(false);
@@ -420,7 +416,7 @@ export const ApiEndpointRequestResponse: React.FC<{
               </div>
             </div>
             <div className="nx-mt-2 nx-mb-4 nx-border-t nx-border-gray-300" />
-            {!context?.isLoggedIn && isBearerTokenRequired && (
+            {isBearerTokenRequired && (
               <div className="md:nx-flex nx-block nx-items-center nx-ml-4">
                 <div className="nx-flex nx-gap-2 nx-w-1/4">
                   <p className="nextra-content nx-text-sm">
@@ -530,7 +526,7 @@ export const ApiEndpointRequestResponse: React.FC<{
               <div className="nx-w-1/4">
                 <button
                   className="nx-bg-purple hover:nx-bg-purple-500 nx-text-white nx-py-2 nx-px-4 nx-rounded-xxl nx-text-sm nx-mt-6"
-                  onClick={hitRequest}
+                  onClick={hitRequestWithoutLogin}
                 >
                   Execute
                 </button>

diff --git a/components/footer.tsx b/components/footer.tsx
@@ -208,7 +208,7 @@ const Footer: React.FC = () => {
             <div className={styles.footerInputWrapper}>
               <div className={styles.footerInput}>
                 <span className={styles.footerText}>
-                  Sign up to for developer updates
+                  Sign up for developer updates
                 </span>
                 <div className={styles.inputBox}>
                   <input

diff --git a/index-data-to-algolia.mjs b/index-data-to-algolia.mjs
@@ -5,8 +5,11 @@ import path from "node:path";
 import matter from "gray-matter";
 import striptags from "striptags";
 
-const client = algoliasearch("J27DIPDG4S", "");
-const index = client.initIndex("12-6-24-index");
+const client = algoliasearch(
+  `${process.env.NEXT_PUBLIC_ALGOLIA_APP_ID}`,
+  `${process.env.NEXT_PUBLIC_ALGOLIA_API_KEY}`,
+);
+const index = client.initIndex(`${process.env.NEXT_PUBLIC_ALGOLIA_INDEX}`);
 
 const docsPath = path.join(process.cwd(), "pages");
 

diff --git a/k8s/build-img.py b/k8s/build-img.py
@@ -19,7 +19,11 @@
 BUILD_ENV_VARS = (
     'BACKEND_URL',
     'NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID',
-    'SENDER_TOKEN',
+    'NEXT_PUBLIC_ALGOLIA_APP_ID',
+    'NEXT_PUBLIC_ALGOLIA_API_KEY',
+    'NEXT_PUBLIC_ALGOLIA_INDEX',
+    'NEWSLETTER_BASE_URL',
+    'SENDER_TOKEN'
 )
 
 def _profile(text: str) -> str:

diff --git a/pages/api/api-requests.ts b/pages/api/api-requests.ts