Skip to content

Commit

Permalink
removed public docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ntotten committed Oct 9, 2023
1 parent 0998ee4 commit f699c9e
Show file tree
Hide file tree
Showing 114 changed files with 19 additions and 28 deletions.
8 changes: 4 additions & 4 deletions docs/articles/archiving-requests-to-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Once you have your container you'll need the URL - you can get it on the
> to deploy to your Zuplo account:
> https://github.com/zuplo/samples-req-archive-filestorage
![Untitled](/media/guides/archiving-requests-to-storage/Untitled.png)
![Untitled](https://cdn.zuplo.com/assets/992a25dd-aea8-40b3-b97f-49bb1b35cd6a.png)

This URL will be the `blobPath` in our policy options.

Expand All @@ -29,13 +29,13 @@ permission. Choose a sensible start and expiration time for your token. Note, we
do not recommend restricting IP addresses because Zuplo runs at the edge in over
200 data-centers world-wide.

![Untitled](/media/guides/archiving-requests-to-storage/Untitled_1.png)
![Untitled](https://cdn.zuplo.com/assets/8c024798-68c9-41ea-a58b-d6ff7097623d.png)

Then generate your SAS token - copy the token (not the URL) to the clipboard and
enter it into a new environment variable in your zup called `BLOB_CREATE_SAS`.
You'll need another environment variable called `BLOB_CONTAINER_PATH`.

![Untitled](/media/guides/archiving-requests-to-storage/Untitled_2.png)
![Untitled](https://cdn.zuplo.com/assets/5d0f5f76-9239-43e6-9516-1513b5990e83.png)

> Note - production customers should talk to a Zuplo representative to get help
> managing their secure keys.
Expand Down Expand Up @@ -114,4 +114,4 @@ property of your routes.

Here's the policy in action:

![2021-11-21 22.51.33.gif](/media/guides/archiving-requests-to-storage/2021-11-21_22.51.33.gif)
![2021-11-21 22.51.33.gif](https://cdn.zuplo.com/assets/2eee0cc9-5c4a-4f8a-ad5a-d1554da45215.gif)
2 changes: 1 addition & 1 deletion docs/articles/custom-ci-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Keys to authenticate. You can find your API Key by following these steps:
2. Select the project that you want to work on.
3. Click on the "Settings" tab and navigate to the "Zuplo API Keys" section.

![Zuplo API Keys](../../public/media/api-keys/zuplo-api-keys.png)
![Zuplo API Keys](https://cdn.zuplo.com/assets/57cf5417-1d98-49f2-8762-0eadc5f34d10.png)

4. Write some tests for your API. We provide a rich set of test helpers and
utils based on BDD. You can see examples of tests at
Expand Down
4 changes: 2 additions & 2 deletions docs/articles/dev-portal-adding-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Within your project in the Zuplo Portal, you will notice a `Docs` directory,
with an `index.md` and `sidebar.json` file. `index.md` is a custom page we
created to get you started.

![Docs Folder](../../public/media/developer-portal/adding-pages/docs-folder.png)
![Docs Folder](https://cdn.zuplo.com/assets/e49b5626-e013-45bd-81fc-28e214102ead.png)

Navigate to `index.md`, and make some changes to the markdown. If you are
unfamiliar with Markdown, check out [this guide](https://www.markdownguide.org/)
Expand All @@ -23,7 +23,7 @@ to get started. You can also create a new docs page via the new file button.
You can preview what your page will look like in the developer portal by
clicking the 'Markdown Preview' tab above the editor.

![Markdown Preview](../../public/media/developer-portal/adding-pages/style-preview.png)
![Markdown Preview](https://cdn.zuplo.com/assets/cbc42890-83a2-4cf0-9bf3-6df0a6c81cf1.png)

## Configuring the Sidebar

Expand Down
16 changes: 8 additions & 8 deletions docs/articles/dev-portal-supabase-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Unfamiliar with Next JS? Try out the

Once your repo and environment variables are setup, you should see the following

![img](../../public/media/supabase-auth/initial-login.png)
![img](https://cdn.zuplo.com/assets/0e91e59a-0631-4708-b92d-89cb16214169.png)

Once you are ready, deploy your project to production.

Expand All @@ -54,7 +54,7 @@ Navigate to Authentication > URL Configuration > Site URL and paste in the full
URL (ex. https://nextjs-with-supabase-xi-seven.vercel.app) in the Site URL
field.

![img](../../public/media/supabase-auth/supabase-site-url.png)
![img](https://cdn.zuplo.com/assets/d5ef498f-62fe-4b83-b197-632256231d93.png)

## 3/ Configuring Your Developer Portal To Use Supabase Auth

Expand All @@ -70,7 +70,7 @@ endpoints (ex. `https://nextjs-with-supabase-xi-seven.vercel.app/login`). Your
developer portal will navigate to these pages to create and end sessions. Your
Authentication Settings should look like this once you are done:

![img](../../public/media/supabase-auth/dev-portal.png)
![img](https://cdn.zuplo.com/assets/792491b3-7098-4066-ab75-4703821e5b3c.png)

Or in the JSON file:

Expand All @@ -95,7 +95,7 @@ key is used to securely connect your Supabase Auth App with the Developer
Portal. From the side nav, go to your Project Settings and then click on Zuplo
API Keys. Copy your API key.

![img](../../public/media/supabase-auth/copy-key.png)
![img](https://cdn.zuplo.com/assets/b7d40f0a-0180-4aea-9f66-b165dec44a09.png)

## 5/ Connecting Your Supabase Auth App to the Dev Portal

Expand Down Expand Up @@ -255,21 +255,21 @@ Auth App codebase from earlier.
of the Developer Portal Settings) and click the “Sign In” button at the top
right

![img](../../public/media/supabase-auth/dev-portal-loaded.png)
![img](https://cdn.zuplo.com/assets/d37b8bf7-ad63-4d77-965f-5868404a4c77.png)

9. You should be redirected to your Supabase Auth App. Enter the email and
password and click “Sign Up”.
10. A email verification link will be sent to your email. Open the email and
click the confirmation link

![img](../../public/media/supabase-auth/email.png)
![img](https://cdn.zuplo.com/assets/003704d2-6786-43dc-a70a-d9f88cc34fc7.png)

11. You will be redirected back to the Dev portal and be signed into your
Supabase account!

### Sign in Support

![img](../../public/media/supabase-auth/supabase-login.gif)
![img](https://cdn.zuplo.com/assets/db2fce79-4dd9-4b6a-9760-231991df2ec2.gif)

Now that you have created your first user, follow the guide below to allow them
to sign into your Supabase project via the Developer Portal
Expand Down Expand Up @@ -419,7 +419,7 @@ how to sign them out.

### (Optional) Additional Auth Provider Support via Supabase

![img](../../public/media/supabase-auth/supabase-github-login.gif)
![img](https://cdn.zuplo.com/assets/519dd3a2-53b7-4c76-bdc4-1dd395e9e37c.gif)

Supabase allows you to connect
[many different Auth Providers](https://supabase.com/docs/guides/auth/social-login).
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/testing-graphql.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ API Test Console.
easily
4. Paste the JSON Body into the test's Body field and click the Test button

![Docs Folder](../../public/media/guides/testing-graphql/test-request.png)
![Docs Folder](https://cdn.zuplo.com/assets/495192f5-cf33-42c3-b4d6-8090db99117c.png)

## 2/ Using a Third-Party Request Tool

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ by following these steps:
2. Select the project that you want to work on.
3. Click on the "Settings" tab and navigate to the "Zuplo API Keys" section.

![Zuplo API Keys](../../public/media/api-keys/zuplo-api-keys.png)
![Zuplo API Keys](https://cdn.zuplo.com/assets/495192f5-cf33-42c3-b4d6-8090db99117c.png)

All commands take an `--api-key` argument. For example, to list your zups, run:

Expand Down
2 changes: 1 addition & 1 deletion docs/handlers/url-rewrite.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Rewrite Handler can be added to any route using the Route Designer. Open the
click **routes.oas.json**. Inside any route, select **URL Rewrite** from the
**Request Handlers** drop-down.

![Url Rewrite Handler selection](../../public/media/url-rewrite-handler-selection.png)
![Url Rewrite Handler selection](https://cdn.zuplo.com/assets/16bfd918-f5f5-4e5a-bf42-e181a8765d69.png)

In the text box enter the URL to rewrite the request. Values can be mixed into
the URL string using Javascript string interpolation syntax. For example:
Expand Down
2 changes: 1 addition & 1 deletion policies/custom-code-inbound/doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ export default async function (request: ZuploRequest) {

Here is this example working as a gif

![](/media/policies/2021-11-21_21.44.35.gif)
![](https://cdn.zuplo.com/assets/e42be9df-34d2-4835-9465-509046a3c25a.gif)

## Modifying the request headers

Expand Down
9 changes: 0 additions & 9 deletions src/build/navigation.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,6 @@ import * as path from "path";
import { createLoader } from "simple-functional-loader";
import * as url from "url";

// export async function getNavigation(): Promise<NavSection[]> {
// const nav: NavSection[] = [];
// for (const rawSection of navigation) {
// const section = await buildNavSection(rawSection);
// nav.push(section);
// }
// return nav;
// }

const __filename = url.fileURLToPath(import.meta.url);

function buildNavSection(rawSection) {
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit f699c9e

Please sign in to comment.