Skip to content

Commit 5ee0420

Browse files
authored
DOCSP-30181 Project UI Overview Page (#22)
* DOCSP-30181 Project UI Overview Page
1 parent 06b228e commit 5ee0420

File tree

3 files changed

+51
-0
lines changed

3 files changed

+51
-0
lines changed
435 KB
Loading

source/projects/overview.txt

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
.. _rm-project-overview:
2+
3+
=======================
4+
User Interface Overview
5+
=======================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Review the UI element descriptions to understand how you can use the UI
14+
to manage the project appearance, functionality, and capabilities.
15+
16+
.. figure:: /img/projects/project-overview.png
17+
:alt: Project Overview Screen
18+
:lightbox:
19+
20+
UI Elements
21+
-----------
22+
23+
.. list-table::
24+
:header-rows: 1
25+
:widths: 30 70
26+
27+
* - UI Element
28+
- Description
29+
30+
* - Top Navigation Bar
31+
- Switch between different contexts, including :guilabel:`Mapping`,
32+
:guilabel:`Code Generation`, and :guilabel:`Data Migration` views.
33+
You can also navigate back to the project home screen,
34+
configure project settings, and access the help menu.
35+
36+
* - Left Pane
37+
- :guilabel:`Manage` your relational connections. Filter and
38+
toggle visibility of your database entities.
39+
40+
* - Diagram Toolbar
41+
- Select diagram layout options, add synthetic foreign keys, and
42+
create additional diagram tabs.
43+
44+
* - Diagrams
45+
- View relational and MongoDB diagrams, view field names, and data types.
46+
Control diagram zoom level and view the entity mini-map.
47+
48+
* - Right Pane
49+
- View, edit, delete, and add mapping rules. Select and rename fields
50+
included in a mapping rule. Add and remove table filters.

source/projects/projects.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ There are multiple options for you to create a project:
4343
/projects/create-project-live-connection
4444
/projects/create-project-loading-schema-files
4545
/projects/create-project-sample-schema
46+
/projects/overview
4647
/projects/configure-settings
4748
/projects/manage-relational-connection
4849
/projects/import-project

0 commit comments

Comments
 (0)