Skip to content

Commit 638d26e

Browse files
ltran-mdb2mdb-ashley
ltran-mdb2
and
mdb-ashley
authored
DOCSP 35174 Merging Diagram Task Pages (#88)
* DOCSP 35172 Stage Diagram Task Pages TOC (#77) * DOCSP-35172 setting pages * DOCSP-24409 Create diagrams * DOCSP-24409 copy edits * DOCSP-24409 copy edits * DOCSP-24409 copy edits * DOCSP-24409 copy edits * DOCSP-24409 formatting procedure * DOCSP-24409 formatting procedure * DOCSP-24409 formatting procedure * DOCSP-24409 formatting procedure * DOCSP-24409 formatting procedure * DOCSP-24409 formatting procedure * DOCSP-24410 rename diagrams * DOCSP-24410 rename diagrams * DOCSP-24410 rename diagrams * DOCSP-24410 rename diagrams * DOCSP-24410 rename diagrams * DOCSP-24410 rename diagrams * DOCSP-25031 clone diagrams * DOCSP-25031 clone diagrams * DOCSP-25031 clone diagrams * DOCSP-25031 clone diagrams * DOCSP-24410 rename diagrams * DOCSP-25031 clone diagram * DOCSP-25031 clone diagram * DOCSP-25031 removing one from after click * DOCSP-24410 removing on from after click * DOCSP-25031 adding period after steps * DOCSP-24410 adding labels, removing periods, adding icon * DOCSP-24409 removing step period * DOCSP-25031 removing step periods and adding labels * DOCSP-24410 fixing labels * DOCSP-25031 adding Mapping label * DOCSP-25032 delete diagrams * DOCSP-24409 copy edits: * DOCSP-24409 adding plus icon * DOCSP-24409 fixing image height * DOCSP-25032 editing att and last step * DOCSP-25032 updating formatting and adding image * DOCSP-25032 updating formatting and adding image * DOCSP-25032 adding icons * DOCSP-24409 new image and changing ui element names * DOCSP-24409 fixing formatting * DOCSP-24409 removing duplicate word * DOCSP-24410 updating ui elements * DOCSP-24409 updating image * DOCSP-24410 updating image * DOCSP-24410 fixing header * DOCSP-24410 fixing header * DOCSP-25032 adding icons and images * DOCSP-25031 typo * DOCSP-25032 copy edits * DOCSP-24409 tech edits * DOCSP-24409 edits from Ian * DOCSP-25032 update title * DOCSP-25031 update title * DOCSP-24410 update title * DOCSP-35617 updating Create a Diagram title and minimalism edits * DOCSP-25032 editing title * DOCSP-25031 editing title * DOCSP-24410 editing title * DOCSP-24410 editing image * DOCSP-25031 updating image * DOCSP-25032 updating image * DOCSP-25031 copy edits * DOCSP-24410 copy edits round 2 * DOCSP-25032 copy edits round 2 * DOCSP-24410 tech edit * DOCSP-24410 tech edit * DOCSP-24410 removing relational migrator phrase * DOCSP-35174 empty commit * DOCSP-35174 removing duplicate images --------- Co-authored-by: Ashley Brown <[email protected]>
1 parent a19385f commit 638d26e

File tree

11 files changed

+291
-1
lines changed

11 files changed

+291
-1
lines changed

‎snooty.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ toc_landing_pages = [
3232
"connection-strings/connection-strings",
3333
"code-generation",
3434
"code-generation/generate-app-code",
35-
"code-generation/query-converter"
35+
"code-generation/query-converter",
36+
"diagrams/manage-diagrams"
3637
]
3738

3839
[constants]

‎source/diagrams/diagrams.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Get Started
4646

4747
- :ref:`rm-understand-diagrams`
4848

49+
- :ref:`rm-create-diagrams`
50+
4951
- :ref:`rm-navigate-diagrams`
5052

5153
- :ref:`rm-apply-layout`
@@ -56,4 +58,5 @@ Get Started
5658
:titlesonly:
5759

5860
/diagrams/understand-diagrams
61+
/diagrams/manage-diagrams
5962
/diagrams/navigate-diagrams/navigate-diagrams

‎source/diagrams/manage-diagrams.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. _rm-manage-diagrams:
2+
3+
===============
4+
Manage Diagrams
5+
===============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
The following pages outline the details and specifics of how to manage
14+
diagrams in Relational Migrator.
15+
16+
Get Started
17+
-----------
18+
19+
- :ref:`rm-create-diagrams`
20+
- :ref:`rm-clone-diagrams`
21+
- :ref:`rm-rename-diagrams`
22+
- :ref:`rm-delete-diagrams`
23+
24+
.. toctree::
25+
:titlesonly:
26+
:hidden:
27+
28+
/diagrams/manage-diagrams/create-diagrams
29+
/diagrams/manage-diagrams/clone-diagrams
30+
/diagrams/manage-diagrams/rename-diagrams
31+
/diagrams/manage-diagrams/delete-diagrams

‎source/diagrams/manage-diagrams/clone-diagrams.txt

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
.. _rm-clone-diagrams:
2+
3+
===============
4+
Clone a Diagram
5+
===============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can clone existing diagrams on the :guilabel:`Mapping` screen of
14+
Relational Migrator.
15+
16+
About this Task
17+
---------------
18+
19+
- You can clone one or more diagrams to create new diagrams that contain
20+
the same entities as existing diagrams.
21+
- Once you clone a diagram, you can edit, :ref:`rename
22+
<rm-rename-diagrams>`, and :ref:`delete <rm-delete-diagrams>` your new
23+
diagram.
24+
25+
26+
Steps
27+
-----
28+
29+
.. procedure::
30+
:style: connected
31+
32+
.. step:: Navigate to the diagram you want to clone
33+
34+
Click the name of the diagram in the Diagram Toolbar to display the
35+
diagram.
36+
37+
.. image:: /img/diagrams/diagram-toolbar.png
38+
:alt: Diagram toolbar
39+
40+
.. step:: Open the :guilabel:`Diagram Properties` pane
41+
42+
Click the :icon-fa5:`chevron-circle-right` arrow button to open the
43+
:guilabel:`Diagram Properties` pane.
44+
45+
.. image:: /img/diagrams/diagram-properties.png
46+
:alt: Diagram Properties pane
47+
48+
The :guilabel:`Diagram Properties` pane displays the active diagram name and
49+
notes.
50+
51+
.. step:: Click the :icon-fa5:`ellipsis-h` button in the :guilabel:`Diagram Properties` pane
52+
53+
.. image:: /img/diagrams/diagram-options.png
54+
:alt: Diagram Properties Options menu
55+
56+
A menu opens.
57+
58+
.. step:: Click the Duplicate Diagram option
59+
60+
A new diagram with the same entities as the duplicated diagram
61+
opens. The visibility of entities on your new diagram is identical
62+
to the duplicated diagram.
63+
64+
.. note ::
65+
66+
Relational Migrator does not clone the duplicated diagram's
67+
name and notes to the new diagram.

‎source/diagrams/manage-diagrams/create-diagrams.txt

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. _rm-create-diagrams:
2+
3+
================
4+
Create a Diagram
5+
================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can create new diagrams on the :guilabel:`Mapping` screen of
14+
Relational Migrator. You can also create multiple diagrams and navigate
15+
between them to view specific entities of your data model. By default,
16+
Relational Migrator creates the :guilabel:`Main Diagram` with a
17+
Relational view and a MongoDB view.
18+
19+
About this Task
20+
---------------
21+
22+
- Creating diagrams allows you to visualize tables, foreign key
23+
relationships, and data types.
24+
- After you create a diagram, you can
25+
:ref:`clone <rm-clone-diagrams>`, :ref:`rename <rm-rename-diagrams>`,
26+
and :ref:`delete <rm-delete-diagrams>` your new diagram.
27+
- You must have at least one digram on your Diagram Toolbar.
28+
- Relational Migrator includes diagrams when you import and export
29+
projects.
30+
31+
Steps
32+
-----
33+
34+
.. procedure::
35+
:style: connected
36+
37+
.. step:: Click the :icon-lg:`Plus` button on the Diagram Toolbar
38+
39+
.. image:: /img/diagrams/create-diagram.png
40+
:alt: Create Diagram in Diagram View Pane
41+
42+
A new blank diagram opens. By default, the diagram view pane hides
43+
all entities in the project. Relational Migrator displays the new
44+
diagram on the :guilabel:`Mapping` screen.
45+
46+
.. note::
47+
48+
Diagram tabs appear in the order that the diagrams were created. You
49+
cannot reorder diagram tabs.
50+
51+
Learn More
52+
----------
53+
54+
- :ref:`rm-clone-diagrams`
55+
- :ref:`rm-rename-diagrams`
56+
- :ref:`rm-delete-diagrams`

‎source/diagrams/manage-diagrams/delete-diagrams.txt

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
.. _rm-delete-diagrams:
2+
3+
================
4+
Delete a Diagram
5+
================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can delete diagrams on the :guilabel:`Mapping` screen.
14+
15+
About this Task
16+
---------------
17+
18+
Relational Migrator requires at least one diagram in your project. You
19+
must have at least two diagrams before you can delete a diagram.
20+
21+
Steps
22+
-----
23+
24+
.. procedure::
25+
:style: connected
26+
27+
.. step:: Navigate to the diagram you want to delete
28+
29+
Click the name of the diagram in the Diagram Toolbar to display the
30+
diagram.
31+
32+
.. image:: /img/diagrams/diagram-toolbar.png
33+
:alt: Diagram toolbar
34+
35+
.. step:: Open the :guilabel:`Diagram Properties` pane
36+
37+
Click the :icon-fa5:`chevron-circle-right` arrow button to open
38+
the :guilabel:`Diagram Properties` pane.
39+
40+
.. image:: /img/diagrams/diagram-properties.png
41+
:alt: Diagram Properties pane
42+
43+
The :guilabel:`Diagram Properties` pane displays the active diagram name and
44+
notes.
45+
46+
.. step:: Click the :icon-fa5:`ellipsis-h` button in the :guilabel:`Diagram Properties` pane
47+
48+
A menu opens.
49+
50+
.. image:: /img/diagrams/diagram-options.png
51+
:alt: Diagram Properties Options menu
52+
53+
.. step:: Click the :guilabel:`Delete Diagram` option
54+
55+
A confirmation box opens.
56+
57+
.. step:: Click the :guilabel:`Delete Diagram` button in the confirmation box.
58+
59+
Once you confirm that you want to delete the selected diagram,
60+
Relational Migrator deletes the diagram. This step cannot be
61+
undone.
62+
63+
Learn More
64+
----------
65+
66+
- :ref:`rm-create-diagrams`
67+
- :ref:`rm-rename-diagrams`
68+
- :ref:`rm-clone-diagrams`
69+
70+

‎source/diagrams/manage-diagrams/rename-diagrams.txt

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
.. _rm-rename-diagrams:
2+
3+
================
4+
Rename a Diagram
5+
================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can rename diagrams on the :guilabel:`Mapping` screen. Relational
14+
Migrator displays diagram names on the Diagram Toolbar.
15+
16+
About this Task
17+
---------------
18+
19+
- You can rename diagrams to customize your diagram properties.
20+
- Relational Migrator displays your diagram names on the Diagram Toolbar
21+
of the :guilabel:`Mapping` screen and in the :guilabel:`Diagram
22+
Properties` pane.
23+
24+
Steps
25+
-----
26+
27+
.. procedure::
28+
:style: connected
29+
30+
.. step:: Navigate to the diagram you want to rename
31+
32+
In the Diagram Toolbar, click the name of the diagram to display the
33+
diagram.
34+
35+
.. image:: /img/diagrams/diagram-toolbar.png
36+
:alt: Diagram toolbar
37+
38+
.. step:: Open the :guilabel:`Diagram Properties` pane
39+
40+
Click the :icon-fa5:`chevron-circle-right` arrow button to open
41+
the :guilabel:`Diagram Properties` pane.
42+
43+
.. image:: /img/diagrams/diagram-properties.png
44+
:alt: Diagram Properties pane
45+
46+
The :guilabel:`Diagram Properties` pane displays the active
47+
diagram name and notes. By default, Relational Migrator names
48+
diagrams in the order they were created and leaves the notes field
49+
empty.
50+
51+
.. step:: Enter your new diagram name in the Name box
52+
53+
When you click outside the Name box, Relational Migrator
54+
automatically saves your new diagram name and updates the Diagram
55+
Toolbar.
56+
57+
Learn More
58+
----------
59+
60+
- :ref:`rm-create-diagrams`
61+
- :ref:`rm-clone-diagrams`
62+
- :ref:`rm-delete-diagrams`

‎source/img/diagrams/create-diagram.png

44.6 KB
Loading

‎source/img/diagrams/diagram-options.png

14.2 KB
Loading

‎source/img/diagrams/diagram-properties.png

10.6 KB
Loading

‎source/img/diagrams/diagram-toolbar.png

48.3 KB
Loading

0 commit comments

Comments
 (0)