Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Harmonize click link/button formatting #427

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/articles/accounts/managing-account-members.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ manage users in your account.

## Add Account Member

To start, navigate to the account settings page by clicking on your user icon in
To start, navigate to the account settings page by clicking your user icon in
the top right corner of the screen and selecting "Settings" from the dropdown
menu.

Expand Down Expand Up @@ -40,6 +40,6 @@ the role from the drop down.

## Removing a Member

To remove a user from the account, click on the remove icon next to the user.
To remove a user from the account, click the remove icon next to the user.

![Remove Member](../../../public/media/managing-account-members/image-4.png)
4 changes: 2 additions & 2 deletions docs/articles/accounts/managing-project-members.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ project level roles in order to grant them access to specific project resources.

## Add Project Member

To manage project members, navigate to the project settings page and click on
the "Members" tab. Here you can see a list of all members in the project and
To manage project members, navigate to the project settings page and click
the **Members** tab, which shows a list of all members in the project and
their roles.

![Project Members](../../../public/media/managing-project-members/image-1.png)
Expand Down
6 changes: 3 additions & 3 deletions docs/articles/accounts/zuplo-api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ accessible areas such as GitHub repositories.

## Creating an API Key

To start, navigate to the account settings page by clicking on your user icon in
To start, navigate to the account settings page by clicking your user icon in
the top right corner of the screen and selecting "Settings" from the dropdown
menu. Click the "API Keys" tab to view the API keys in your account that you
menu. Click the **API Keys** tab to view the API keys in your account that you
have access to.

![API Keys](../../../public/media/zuplo-api-keys/image.png)
Expand All @@ -41,7 +41,7 @@ will need to create a new API key.
## Deleting an API Key

API Keys can be deleted by selecting the delete button on the list page or by
opening the details page for the key and clicking the "Delete" button at the
opening the details page for the key and clicking the **Delete** button at the
bottom of the page.

![Delete API Key](../../../public/media/zuplo-api-keys/image-2.png)
Expand Down
4 changes: 2 additions & 2 deletions docs/articles/add-api-to-backstage.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ spec:
```

You should now be able to see your API under the APIs tab in Backstage. If you
navigate to your API and click the 'DEFINITION' tab - you can even preview your
navigate to your API and click the **DEFINITION** tab - you can even preview your
OpenAPI spec.

![OpenAPI spec](../../public/media/add-api-to-backstage/image-6.png)
Expand Down Expand Up @@ -126,7 +126,7 @@ Save and commit this file.
### 2/ Add your API Component to Backstage

You can register existing APIs in your catalog directly from Backstage. Navigate
to the APIs tab, and click 'REGISTER EXISTING API'.
to the APIs tab, and click **REGISTER EXISTING API**.

![APIs list](../../public/media/add-api-to-backstage/image-5.png)

Expand Down
4 changes: 2 additions & 2 deletions docs/articles/archiving-requests-to-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ requests to Azure Blob Storage. We also have a post on

First, let's set up Azure. You'll need a container in Azure storage
([docs](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal)).
Once you have your container you'll need the URL - you can get it on the
`properties` tab of your container as shown below.
Once you have your container you'll need the URL - click the
**Properties** tab of your container as shown below.

> **Note** - this sample is available as a Zup It on GitHub - just click ZupIt!
> to deploy to your Zuplo account:
Expand Down
4 changes: 2 additions & 2 deletions docs/articles/bonus-dynamic-rate-limiting.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ information to rate limit them differently.
## 2/ Add a Custom Code Module

Navigate back to the Code tab. Now add a new module to the files section by
clicking on the `+` next to the **modules** folder and choose new empty module.
clicking the `+` next to the **modules** folder and choose new empty module.
Name the module `rate-limit.ts`.

![New module](../../public/media/step-3-add-rate-limiting/image-3.png)
Expand Down Expand Up @@ -102,7 +102,7 @@ export function rateLimit(request: ZuploRequest, context: ZuploContext) {
## 3/ Update your Policy

Now we'll reconfigure the rate-limiting policy to wire up our custom function.
Find the policy in the **Route Designer** and click edit.
Find the policy in the **Route Designer** and click **Edit**.

![Edit Policy](../../public/media/step-3-add-rate-limiting/image-4.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/articles/custom-ci-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ following these steps:

1. Navigate to [portal.zuplo.com](https://portal.zuplo.com) and log in.
2. Select the account that you want to work on.
3. Click on the "Settings" tab and navigate to the "API Keys" section.
3. Click the **Settings** tab and navigate to the **API Keys** section.
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
[samples](https://github.com/zuplo/zup-cli-example-project/tree/main/tests).
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/custom-domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ for your Zuplo project.
### 1. Navigate to your project's Custom Domain Settings

Go to your project in the Zuplo portal and open to the **Settings** tab (1),
then select **Custom Domain** (2) and click on the `Add New Custom Domain`
then select **Custom Domain** (2) and click the **Add New Custom Domain**
button to open the `New Custom Domain` configuration modal.

![Custom Domain](../../public/media/custom-domains/image.png)
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/dev-portal-adding-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ to get started. You can also create a new docs page via the new file button.
## Previewing Your Changes

You can preview what your page will look like in the developer portal by
clicking the 'Markdown Preview' tab above the editor.
clicking the **Markdown Preview** tab above the editor.

![Markdown Preview](../../public/media/developer-portal/adding-pages/style-preview.png)

Expand Down
16 changes: 8 additions & 8 deletions docs/articles/dev-portal-keycloak-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_label: Keycloak Setup
This guide will walk you through setting up Keycloak as the authentication
provider for your Zuplo hosted developer portal.

### 1/ Create OAuth Application
### 1. Create OAuth Application
cadamini marked this conversation as resolved.
Show resolved Hide resolved

Navigate to your admin console and create a new client. The Client ID can be
anything you want, but for this example, we will use `zuplo-dev-portal`.
Expand All @@ -17,23 +17,23 @@ click "Next".

![Keycloak Client](../../public/media/dev-portal-keycloak-auth/image.png)

### 2/ Set the Client Capabilities
### 2. Set the Client Capabilities
cadamini marked this conversation as resolved.
Show resolved Hide resolved

In the Authentication flow section, enable the "Standard flow" and disable
"Direct access grants". Leave "Client authentication" and "Authorization" set to
"off". Click "Next".
"off". Click **Next**.

![Client Capabilities](../../public/media/dev-portal-keycloak-auth/image-1.png)

### 3/ Set the Login Settings
### 3. Set the Login Settings
cadamini marked this conversation as resolved.
Show resolved Hide resolved

In the "Valid Redirect URIs" field, enter the URL of your Zuplo Dev Portal with
the base path (this defaults to `/docs/`). Make sure you have the trailing slash
set. Click "Save".
set. Click **Save**.

![Login settings](../../public/media/dev-portal-keycloak-auth/image-3.png)

### 4/ Find the Issuer URL
### 4. Find the Issuer URL
cadamini marked this conversation as resolved.
Show resolved Hide resolved

Open the "Realm settings" tab in your Keycloak admin console. And click the link
to "OpenID Endpoint Configuration". This will open a JSON document. Find the
Expand All @@ -44,13 +44,13 @@ Dev Portal.

![JSON file](../../public/media/dev-portal-keycloak-auth/image-5.png)

### 3/ Configure the Developer Portal
### 5. Configure the Developer Portal
cadamini marked this conversation as resolved.
Show resolved Hide resolved

Inside of the Zuplo Developer portal navigate to the **Code Editor** tab and
open the `dev-portal.json` file. Under the "Authentication" section, set the
"Provider" to "OpenID Connect". Set the "Authority" value to the `issuer` value
you copied from the JSON file in the previous step. Set the "Client ID" value to
the value you set in step 1 (in our example this is `zuplo-dev-portal`). Click
"Save".
**Save**.

![developer portal settings](../../public/media/dev-portal-keycloak-auth/image-6.png)
14 changes: 7 additions & 7 deletions docs/articles/dev-portal-supabase-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ Or in the JSON file:

Before we leave the Zuplo Portal, you’ll need to grab your Zuplo API key. This
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.
Portal. From the side nav, go to your Project Settings and then click **Zuplo
API Keys**. Copy your API key.

![img](../../public/media/supabase-auth/copy-key-updated.png)

Expand Down Expand Up @@ -381,10 +381,10 @@ to sign into your Supabase project via the Developer Portal
```

5. Deploy your code (make sure to set an environment variable for you
ZUPLO_API_KEY) and navigate to your Dev Portal. Then click the Sign In
ZUPLO_API_KEY) and navigate to your Dev Portal. Then click the **Sign In**
button
6. You should be redirected to your Supabase Auth App. Enter the email and
password of an existing user and click Sign In.
password of an existing user and click **Sign In**.
7. You will be redirected back to the Dev portal and be signed into your
Supabase account!

Expand Down Expand Up @@ -414,7 +414,7 @@ how to sign them out.
```

2. Deploy your code and navigate to your Dev Portal. Sign in if you aren’t
already. Then click your user icon and Logout
already. Then click your user icon and **Logout**

3. You should now be signed out of your Supabase Account

Expand Down Expand Up @@ -490,9 +490,9 @@ need to have completed the Sign Up Support section above first**

You should now see a GitHub button on your login page

4. Deploy your code and navigate to your Dev Portal. Then click the Sign In
4. Deploy your code and navigate to your Dev Portal. Then click the **Sign In**
button
5. You should be redirected to your Supabase Auth App. Click the GitHub button
5. You should be redirected to your Supabase Auth App. Click the **GitHub** button
6. You will be redirected to the GitHub OAuth flow. Sign into GitHub if you
aren’t already, and navigate through the flow
7. You will be redirected back to the Dev portal and be signed into your GitHub
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/local-development-debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ npx @zuplo/cli dev --debug-port 9229
```

3. Switch to the View > Run and Debug in VS Code. You can now attach the
debugger by selecting "Zuplo Gateway" and clicking the green triangle.
debugger by selecting **Zuplo Gateway** and clicking the green triangle.

![VS code debugging](../../public/media/local-development-debugging/image.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/articles/rename-or-move-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ correct name. Choose the `Advanced` option on the new project dialog.
![Import existing project](../../public/media/source-control/image-1.png)

You should see a list of Orgs and Repos - pick the source repo you wanted to
move and click Create Project from Repository.
move and click **Create Project from Repository**.

Your new project will now be connected to this repo and ready to go.

Expand Down
2 changes: 1 addition & 1 deletion docs/articles/step-1-setup-basic-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ quick overview of them:
![Your First Route](../../public/media/step-1-setup-basic-gateway/image-14.png)

Save your new route (you can click the three-dot menu next to `routes.oas.json`
and then click Save, or press CMD+S).
and then click **Save**, or press **CMD+S**).

You can quickly test this route by clicking the **Test** button next to the
**Path** field. You can use the built in test tool or click the URL to open in a
Expand Down
8 changes: 4 additions & 4 deletions docs/articles/step-2-add-rate-limiting.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ pipeline.

![Add policy](../../public/media/step-2-add-rate-limiting/image.png)

Search for the rate limiting policy (not the "Complex" one) and click on it!
Search for the rate limiting policy (not the "Complex" one) and click it.

![Add rate-limiting policy](../../public/media/step-2-add-rate-limiting/image-2.png)

Expand All @@ -45,7 +45,7 @@ rest of the policy's documentation and configuration in the right panel.

![Rate limiting policy](../../public/media/step-2-add-rate-limiting/image-3.png)

Click 'OK' to apply the policy, and then save your changes to redeploy.
To apply the policy, click **OK**. Then, save your changes to redeploy.

## 2/ Testing your Policy

Expand All @@ -62,8 +62,8 @@ Your rate limiting policy is now intercepting excess requests, protecting the
Whenever you deploy a new endpoint on Zuplo, it will automatically be added to
your [autogenerated developer documentation portal](./developer-portal.md).

To access your API's developer portal, click the "Gateway deployed" button in
your toolbar and click on the link under Developer Portal.
To access your API's developer portal, click the **Gateway deployed** button in
your toolbar and click the link under Developer Portal.
![Developer portal menu](../../public/media/step-2-add-rate-limiting/image-5.png)
You can also find this link in the Getting Started section of the portal, every
time you navigate to your project.
Expand Down
12 changes: 6 additions & 6 deletions docs/articles/step-3-add-api-key-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ If you test your route, you should get a 401 Unauthorized response
## 2/ Set up an API Key

In order to call your API, you need to configure an API consumer. Go to
**Services**, then click "Configure" on the "API Key Service".
**Services**, then click **Configure** on the "API Key Service".

![API Key Service](../../public/media/step-3-add-api-key-auth/image-2.png)

Expand All @@ -74,15 +74,15 @@ Let's break down the configuration needed.
plan, organization, etc.

Go ahead and fill in `test-consumer` for the Subject. Add your own email as a
Key manager, and leave the metadata empty for now. Click 'Save consumer' once
Key manager, and leave the metadata empty for now. Click **Save consumer** once
you're done.

![New Consumer](../../public/media/step-3-add-api-key-auth/image-3.png)

## 3/ Copy your API Key

After your API Key consumer is created, click the copy button (next to the eye
icon) to copy your new API Key.
After your API Key consumer is created, copy your new API Key by clicking the copy button (next to the eye
icon).

![Copy Key](../../public/media/step-3-add-api-key-auth/image-4.png)

Expand Down Expand Up @@ -115,8 +115,8 @@ management into your existing dashboard. See
Whenever you deploy a new endpoint on Zuplo, it will automatically be added to
your [autogenerated developer documentation portal](./developer-portal.md).

To access your API's developer portal, click the "Gateway deployed" button in
your toolbar and click on the link under Developer Portal.
To access your API's developer portal, click the **Gateway deployed** button in
your toolbar and click the link under Developer Portal.
![Developer portal menu](../../public/media/step-2-add-rate-limiting/image-5.png)

When you use certain policies like API keys, Zuplo will document properties like
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/step-4-deploying-to-the-edge.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ environment we want to update first). Click **Create pull request**.

![GitHub PR](https://cdn.zuplo.com/assets/875b164d-b7ef-4f46-9cdb-8d59354b5b93.png)

When ready, click **Merge pull request**
When ready, click **Merge pull request**.

![Merge PR](https://cdn.zuplo.com/assets/e8c68072-35dc-462a-8161-7a44e40fa1df.png)

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 @@ -16,7 +16,7 @@ API Test Console.
3. Convert your GraphQL Query and GraphQL Variables into a JSON body. You can
use [this tool](https://datafetcher.com/graphql-json-body-converter) to do so
easily
4. Paste the JSON Body into the test's Body field and click the Test button
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)

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ by following these steps:

1. Navigate to [portal.zuplo.com](https://portal.zuplo.com) and log in.
2. Select the account that you want to work on.
3. Click on the "Settings" tab and navigate to the "API Keys" section. Select an
3. Click the **Settings** tab and navigate to the "API Keys" section. Select an
existing API Key or create a new one to use with the CLI.

Most commands take an `--api-key` argument. For example, to list your available
Expand Down