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.

Sign up for GitHub

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

docs(portal): reserved paths #8527

Merged
merged 5 commits into from
Mar 7, 2025
Merged

docs(portal): reserved paths #8527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e85cb71
docs(portal): reserved paths
adamdehaven Mar 7, 2025
3edd494
docs: spelling
adamdehaven Mar 7, 2025
9846aad
docs: add internal endpoint
adamdehaven Mar 7, 2025
20956d1
docs: reword
adamdehaven Mar 7, 2025
ff6bcb9
fix link
lena-larionova Mar 7, 2025
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
2 changes: 2 additions & 0 deletions .github/styles/kong/dictionary.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ Nginx
Nginx's
Node.js
Noname
Nuxt
OAuth
Okta
Okta's
Expand Down Expand Up @@ -293,6 +294,7 @@ healthchecks
hostname
hostnames
href
HTML
http
httpbin
HTTPie
Expand Down
27 changes: 23 additions & 4 deletions app/dev-portal/portals/customization/custom-pages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Custom Pages

Pages are highly customizable using Markdown Components (MDC), allowing to create nested page structures to organize pages and generate URLs/slugs. Visibility controls and Publishing status allow you to stage new Pages, and/or restrict access to logged-in Developers.

To get started creating Pages, navigate to your Dev Portal and select [**Portal Editor**](/dev-portal/portals/portal-editor) from the left sidebar.
To get started creating Pages, navigate to your Dev Portal and select [**Portal Editor**](/dev-portal/portals/customization/portal-editor/) from the left sidebar.

{:.note}
> *Pages are built using Markdown Components (MDC). Additional documentation on syntax, as well as tools for generating components, are available on a [dedicated MDC site](https://portaldocs.konghq.com/).*
Expand Down Expand Up @@ -34,9 +34,28 @@ Example: `about` has a child page, `contact`. The URL for the `contact` page wou
{:.note}
> *`home` is a special page representing the `/` path. If this page is deleted, you'll need to create it from the Pages API.*

#### Reserved paths

The Portal requires a number of reserved paths from the root of the URL to properly function.
You cannot override these paths with custom pages or other functionality.

| Path | Description | RegExp
|:------|:-------|:-------|
| `/login/*` | Login | `^/login(?:\/.*)?` |
| `/register` | Registration | `^/register` |
| `/forgot-password` | Forgot password | `^/forgot-password` |
| `/reset-password` | Reset password | `^/reset-password` |
| `/logout` | Log out | `^/logout` |
| `/apps/*` | Developer applications | `^/apps` |
| `/api/v*/` | Portal API | `^/api\/v\d+\/.*` |
| `/_api/*` | Nuxt server endpoints | `^/_api\/.*` |
| `/api/*` | Nuxt server endpoints | `^/api\/(?!v\d+\/).*` |
| `/npm/*` | CDN Proxy | `^/npm\/.*` |
| `/_preview-mode/*` | Konnect previews | `^/_preview-mode\/.*` |

### Modify a Page

In the middle panel, you can make changes to your MDC content, and instantly see the live Preview.
In the middle panel, you can make changes to your MDC content, and instantly see the live Preview.

Once you have completed your changes, be sure to click **Save**.

Expand Down Expand Up @@ -70,7 +89,7 @@ description: Start building and innovating with our APIs
---
```

With the above front matter, the portal will render the following html tags for your page:
With the above front matter, the portal will render the following HTML tags for your page:

```
<title>Home | Developer Portal</title>
Expand Down Expand Up @@ -105,4 +124,4 @@ image:
width: 300px
height: 200px
---
```
```
Loading