Projects

A Project represents a group of Collections. These Collections contain Extractors.

As you establish Projects, you can name them identically; however, in this case, each Project
must be associated with a different Environment (DEV, STAGING, or PRODUCTION).

Projects can be locked, restricting write and edit operations under each subsequent DOC layer (such as
Collections, Sources, and Snapshots.) You will not have Project access unless you are an ORG_ADMIN,
OPS, or assigned to work on a specific layer of this Project. If your role is ORG MEMBER and you
are attempting to edit a Source, for example, you cannot make changes unless this Source is assigned to you.

Add a Project

projects primary

To add a new Project:

  1. From the left navigation pane, click Projects.

  2. From the top right of the Projects page, click the Add a Project icon or plus (+) symbol.

  3. From the New Project page that now appears, enter text in the Name field.

    The name you enter will autofill the Slug/ID field. You can associate Slug/IDs
    with many DOC platform objects, which serve as self-defined identifiers. Slug/IDs
    can be useful as you reference APIs or create variable names. You cannot change Slug/IDs.
    That noted, ensure they are meaningful.

  4. Use the drop-down arrow to select an Environment.

    You may choose DEV, STAGING, or PRODUCTION. Two projects can have the same name; however,
    in this case, their Environments must be different. For now, the Environment references, generally,
    function as tags or labels.

  5. To share Project information with team members, enter README text.

    This section, which supports the markdown syntax, allows you to provide additional Project context
    and insight.

  6. To store content, click Save. To disregard, click Cancel.

The system stores the Project, creating a Slug Name and Project ID. A path displays near the top middle
of the page. You can click projects to return to that page and view the list of defined Projects.

You can filter and sort these items; in addition, you can use the Search feature or scrollbar to locate
existing Projects.

projects defined

Edit a Project

To edit a Project:

  1. From the Projects page, use the Search feature or scrollbar (if necessary) to locate
    the Project you want to modify.

  2. Click to select this entry.

    projects edit lock readme

    In addition to the Edit or pencil-like icon, a Lock also appears at the top right of this page.
    Projects can be locked, restricting write and edit operations under each subsequent DOC layer
    (such as Collections, Sources, and Snapshots.) You will not have Project access unless you are an
    ORG_ADMIN, OPS, or assigned to work on a specific layer of this Project. If your role is
    ORG MEMBER and you are attempting to edit a Source, for example, you cannot make changes
    unless this Source is assigned to you.

    The View Readme Version History watch-like icon is located near the top center of the page.
    Upon selection, you can view the Preview Version, Published, Updated by, and Actions
    columns. You can click the content in the Preview Version column to view README file
    information. The README file provides additional Project context and insight.

  3. From the top right of the page that now appears, click the Edit Project or pencil-like icon.

    Here, on the Edit Project page, you can modify the Name and Environment fields along with the
    README text. You cannot edit the Slug/ID field.

  4. To store updates, click Save. To disregard, click Cancel.

You cannot delete Projects.