Skip to content

Commit 3db489f

Browse files
authored
DOCSP-47557 Refactors projects section (#236)
* DOCSP-47557 Refactors projects section * Revise landing page content * Moves projects section based on PM feedback * Remove plural * Responds to comments * Converts home guilabel to lg icon * Update UL list spacing in application settings * Small tweaks * Responds to comments
1 parent f74c411 commit 3db489f

11 files changed

+230
-37
lines changed

source/database-connections/database-connections.txt

-1
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,3 @@ For more information, see :ref:`<migrator-without-live-connection>`.
6565
MongoDB </database-connections/mongodb>
6666
Use Without DB Connection </database-connections/migrator-without-live-connection>
6767
Manage Connections </database-connections/manage-database-connections>
68-
Create & Manage Projects </projects>

source/database-connections/manage-database-connections.txt

+18-9
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,14 @@ Steps
6868

6969
To copy a connection:
7070

71-
#. Click the :icon-fa4:`copy` button.
71+
.. procedure::
72+
:style: normal
7273

73-
#. Make any desired changes.
74+
.. step:: Click the :icon-lg:`Copy` icon.
7475

75-
#. Click :guilabel:`Save`.
76+
.. step:: Make any desired changes.
77+
78+
.. step:: Click :guilabel:`Save`.
7679

7780

7881

@@ -92,11 +95,14 @@ Steps
9295

9396
To edit a connection:
9497

95-
#. Click the :icon-lg:`Edit` button.
98+
.. procedure::
99+
:style: normal
100+
101+
.. step:: Click the :icon-lg:`Edit` icon.
96102

97-
#. Make any desired changes, such as renaming the connection or changing the database.
103+
.. step:: Make any desired changes, such as renaming the connection or changing the database.
98104

99-
#. Click :guilabel:`Save`.
105+
.. step:: Click :guilabel:`Save`.
100106

101107

102108

@@ -113,8 +119,11 @@ Steps
113119

114120
To delete a connection:
115121

116-
#. Click the :icon-fa5:`trash` button.
122+
.. procedure::
123+
:style: normal
124+
125+
.. step:: Click the :icon-lg:`Trash` icon.
117126

118-
A warning dialog displays and lists any projects that use the connection.
127+
A warning dialog displays and lists any projects that use the connection.
119128

120-
#. Click :guilabel:`Delete` to confirm.
129+
.. step:: Click :guilabel:`Delete` to confirm.

source/getting-started.txt

+1
Original file line numberDiff line numberDiff line change
@@ -190,3 +190,4 @@ Learn More
190190
:hidden:
191191

192192
UI Overview </getting-started/overview>
193+
Create & Manage Projects </projects>
+48-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,52 @@
11
.. _rm-application-settings:
2+
.. _rm-project-settings:
23

34
====================
45
Application Settings
5-
====================
6+
====================
7+
8+
.. contents:: On this page
9+
:local:
10+
:backlinks: none
11+
:depth: 1
12+
:class: singlecol
13+
14+
You can customize Relational Migrator to meet your specific needs.
15+
Some options are only available in the :guilabel:`Settings` panel.
16+
17+
Settings Location
18+
-----------------
19+
20+
To find the Relational Migrator :guilabel:`Settings` panel, open
21+
Relational Migrator and select :guilabel:`Settings`:
22+
23+
.. figure:: /img/projects/settings-panel-location.png
24+
:alt: Settings panel location for Relational Migrator
25+
26+
Settings
27+
--------
28+
29+
You can configure the following settings:
30+
31+
.. list-table::
32+
:header-rows: 1
33+
:widths: 30 20 50
34+
35+
* - Setting
36+
- Category
37+
- Definition
38+
39+
* - Query Converter
40+
- AI
41+
- When enabled, MongoDB temporarily stores the source and
42+
converted queries to improve the underlying Query Converter
43+
technology. For details, see
44+
`Generative AI FAQ <https://dochub.mongodb.org/core/faq-ai-features>`__ .
45+
46+
* - Theme
47+
- Apperance
48+
- Change the appearance of Relational Migrator.
49+
50+
- ``Auto``: Automatically switch between light and dark themes based on your OS settings.
51+
- ``Light``: Use a light theme.
52+
- ``Dark``: Use a dark theme.

source/projects.txt

+19-21
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _rm-projects:
22

3-
========
4-
Projects
5-
========
3+
==========================
4+
Create and Manage Projects
5+
==========================
66

77
.. contents:: On this page
88
:local:
@@ -12,32 +12,30 @@ Projects
1212

1313
To interact with {+rel-mig+}, you use a project. A project holds
1414
configuration settings, mapping rules, and migration-specific details.
15-
{+rel-mig+} allows you to :ref:`import<import-project>`,
16-
:ref:`export <export-project>`, and :ref:`delete <delete-project>` projects.
17-
You can also :ref:`manage the relational model<rm-manage-relational-model>`
18-
from a project.
1915

20-
Get Started
21-
-----------
16+
Use Cases
17+
---------
2218

23-
There are multiple options for you to create a project:
19+
You can create projects with or without a live connection to your relational
20+
database. To migrate data, Relational Migrator requires a live database
21+
connection. However, you can visualize and model your data without a live
22+
database connection.
2423

25-
.. list-table::
26-
:header-rows: 1
27-
:widths: 50 50
24+
If you already created a Relational Migrator project, you can :ref:`import<import-project>`,
25+
:ref:`export <export-project>`, :ref:`delete <delete-project>`, and
26+
:ref:`rename <rename-project>` your project.
2827

29-
* - Option
30-
- Description
28+
Get Started
29+
-----------
3130

32-
* - :ref:`rm-create-project-live`
33-
- Provide source and destination connection details and migrate data from a live relational system.
34-
* - :ref:`create-project-schema-file`
35-
- Export a Data Definition Language (DDL) file from your relational system and import it into {+rel-mig+}.
36-
* - :ref:`create-project-sample-schema`
37-
- Use a predefined sample schema even if you do not have a relational system to connect to.
31+
- :ref:`rm-create-project-live`
32+
- :ref:`<migrator-without-live-connection>`
33+
- :ref:`<rm-manage-projects>`
3834

3935
.. toctree::
4036
:hidden:
4137
:titlesonly:
4238

39+
Create with Live Database </projects/create-project-live-connection>
40+
Manage Projects </projects/manage-projects>
4341
Project Settings </projects/configure-settings>

source/projects/deleting-projects.txt

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
.. _delete-project:
21

32
================
43
Delete a Project

source/projects/export-project.txt

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
.. _export-project:
21

32
================
43
Export a Project

source/projects/import-project.txt

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
.. _import-project:
21

32
================
43
Import a Project

source/projects/manage-projects.txt

+143
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
.. _rm-manage-projects:
2+
3+
===============
4+
Manage Projects
5+
===============
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can export, import, delete, or rename Relational Migrator projects
16+
from the :guilabel:`home page`.
17+
18+
.. _export-project:
19+
20+
Export a Project
21+
----------------
22+
23+
Export Relational Migrator projects to share a project with other users,
24+
duplicate a project, or back up a project. Before you export your project,
25+
consider the following:
26+
27+
- Relational Migrator can only export ``.relmig`` files.
28+
29+
- Exported project files do not include the migration job history or passwords.
30+
31+
Steps
32+
~~~~~
33+
34+
.. procedure::
35+
:style: normal
36+
37+
.. step:: Open your project commands.
38+
39+
- To open your project commands from the :guilabel:`home page`, click the
40+
:icon-lg:`Ellipsis` icon next to the project.
41+
42+
- To open your project commands from your :guilabel:`open project page`, click
43+
the :icon-lg:`VerticalEllipsis` icon next to the project name.
44+
45+
.. step:: Select :guilabel:`Export`.
46+
47+
.. step:: Click :guilabel:`Export` to confirm.
48+
49+
Your project is exported as a ``.relmig`` file.
50+
51+
.. _import-project:
52+
53+
Import a Project
54+
----------------
55+
56+
Import a project when you want to collaborate on a shared project. You
57+
can also duplicate a project by :ref:`exporting <export-project>` the
58+
project and then importing it. Before you import a project, consider
59+
the following:
60+
61+
- When you import projects, Relational Migrator only uses ``.relmig`` files.
62+
63+
- Relational Migrator rejects files for import and returns an error message in
64+
the following conditions:
65+
66+
- The format of the file cannot be determined.
67+
68+
- Required information is missing from the file.
69+
70+
- The file was exported from an unsupported version of Relational Migrator.
71+
72+
- The version number of the file is older than a well-defined minimum version.
73+
74+
Steps
75+
~~~~~
76+
77+
.. procedure::
78+
:style: normal
79+
80+
.. step:: On your :guilabel:`home page`, select :guilabel:`New Project`.
81+
82+
.. step:: Select :guilabel:`Import an existing project`.
83+
84+
.. step:: Choose a file, or drag and drop the ``.relmig`` file.
85+
86+
.. step:: Click :guilabel:`Import`.
87+
88+
.. _delete-project:
89+
90+
Delete a Project
91+
----------------
92+
93+
Delete a project to remove migration workloads that are no longer needed.
94+
If the last project on the :guilabel:`Recent Projects` page is deleted, the
95+
:guilabel:`New Project` page is displayed.
96+
97+
Steps
98+
~~~~~
99+
100+
.. procedure::
101+
:style: normal
102+
103+
.. step:: From the :guilabel:`project view`, click the :icon-lg:`Home` icon in the top-left corner.
104+
105+
.. step:: Click the :icon-lg:`Ellipsis` icon next to your project of choice. Select :guilabel:`Delete`.
106+
107+
.. step:: Click :guilabel:`Delete` to confirm.
108+
109+
.. warning::
110+
111+
You cannot recover a deleted project.
112+
113+
.. _rename-project:
114+
115+
Rename a Project
116+
----------------
117+
118+
To update the name of an existing project, use the :guilabel:`Rename` option.
119+
120+
Steps
121+
~~~~~
122+
123+
.. procedure::
124+
:style: normal
125+
126+
.. step:: From the project view, click the :icon-lg:`Home` icon in the top-left corner.
127+
128+
.. step:: Click the :icon-lg:`Ellipsis` icon next to your project of choice. Select :guilabel:`Rename`.
129+
130+
.. step:: Enter a new project name.
131+
132+
The new name must be 1-50 characters long and can't be in use by another project.
133+
134+
.. step:: Click :guilabel:`Save`.
135+
136+
Next Steps
137+
----------
138+
139+
- :ref:`<rm-create-project-live>`
140+
- :ref:`<migrator-without-live-connection>`
141+
- :ref:`Connect to Databases <rm-database-connections>`
142+
- :ref:`<rm-mapping-rules>`
143+
- :ref:`<rm-sync-jobs>`

source/projects/project-settings.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _rm-project-settings:
1+
22

33
.. contents:: On this page
44
:local:

source/projects/renaming-projects.txt

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
.. _rename-project:
21

32
================
43
Rename a Project

0 commit comments

Comments
 (0)