Managing the pages in your portal

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

Manage the pages in your portal, as described in the following sections.

About the reserved URL paths

The following URL paths are reserved for use by the developer portal and cannot be specified as the page path (or as the prefix of a nested page path, such as docs/... or apis/...) when creating pages:

  • a
  • accounts/create
  • apis
  • consumers/api
  • create
  • docs
  • files
  • login
  • logout
  • logos
  • my-apps
  • portals/api
  • siteid
  • sites
  • smartdocs
  • teams

The reserved path /create can be used as the target URL of a MenuItem or be linked to from a Page.

The /create reserved path will redirect to the accounts creation page.

Exploring the Pages page

To access the Pages page:

  1. In the Apigee in Cloud console, go to the Distribution > Portals page.

    Go to Portals

    The list of pages in your portal is displayed.

    Click for larger image

    list of pages in the portal

The Pages page lets you:

  • Create a page
  • View page details, including name, relative path, status, visibility, and amount of time since the page was last modified
  • Edit page content and details
  • Manage the visibility of a page in your portal
  • Delete pages in your portal
  • Sort the list of pages by column (the arrow indicates the active column and direction of the sorted content)

Creating a page

To create a new page:

  1. Access the Pages page.
  2. Click +Page.
  3. In the Create a Page dialog, enter the following details:

    Field Description Required?
    Name Name of the page. The page name must be unique within the portal. The name is used in the portal page header and browser tab. Yes
    Path User-friendly relative URL to use for the page (up to 255 characters). For best practices, see Implement search engine optimization (SEO). Defaults to the page name with spaces converted to dashes. The path must meet the following requirements:
    • Use lowercase letters (a-z), numbers (0-9), dashes (-), and forward slashes (/) only. Forward slashes can be used to create nested page paths (for example, guides/getting-started). Spaces and other special characters are not allowed.
    • Start and end with a lowercase letter or number (do not include a leading or trailing / or -).
    • Do not include consecutive dashes (--), consecutive forward slashes (//), or adjacent dashes and forward slashes (/- or -/).
    Note: Avoid specifying a reserved URL path (or a path starting with <reserved-path>/) when creating a page. For a list of reserved URL paths, see About the reserved URL paths.
    Yes

  4. Save the page. Click Save.

Editing the contents of a page

To edit the contents of a page:

  1. Access the Pages page.
  2. Click the name of the page that you want to edit.
  3. Edit the contents of the page. See Developing portal content using the page editor.

Editing the page details

To edit the details for a page, including the name, description, and relative path:

  1. Access the Pages page.
  2. Open the editor. On the row for the page you want to edit, click More, Edit.

  3. Edit the page details.

  4. Save the page. Click Save.

Managing the visibility of a page in your portal

To manage the visibility of a page in your portal:

  1. Access the Pages page.

  2. Open the visibility editor:

    1. On the row for the page you want to modify, click More, Edit.
    2. In the Visibility area, click Edit.
  3. Select one of the following options:

    • Public (visible to anyone) to allow all users to view the page.
    • Authenticated users to allow only registered users to view the page.
    • Selected audiences to select the specific audiences that you want to be able to view the page. For information about managing the audiences defined for your portal, see Managing the audiences for your portal.
  4. Save the visibility settings.

    Click Apply.

Deleting pages from your portal

To delete a page from your portal:

  1. Access the Pages page.

  2. Delete the page.

    1. Click More, Delete.
    2. Type Delete and then click Delete page to confirm.