Skip to content

Commit e349fab

Browse files
ctalauOxygen Content Fusion
ctalau
authored and
Oxygen Content Fusion
committed
Add content about a typical editing session in CF.
1 parent c50c617 commit e349fab

7 files changed

+85
-2
lines changed

‎git-tech-writers/cf_editing_session_workflow.dita

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
3+
<topic id="topic_vkq_4dv_v2c">
4+
<title>Editing Session with Oxygen Content Fusion</title>
5+
<body>
6+
<p>You can use the <xref
7+
href="https://www.oxygenxml.com/content_fusion/content_fusion_authoring.html"
8+
format="html" scope="external">Oxygen Content Fusion authoring features</xref> to
9+
create content in your Git repository.</p>
10+
<p>Here is your usual editing workflow to edit content on a Git branch:</p>
11+
<p>
12+
<ul id="ul_qw2_whv_v2c">
13+
<li>Open the workspace for that branch</li>
14+
<li>Synchronize the workspace</li>
15+
<li>Edit</li>
16+
<li>Pull incoming commits</li>
17+
<li>(Optional) Validate</li>
18+
<li>Commit</li>
19+
</ul>
20+
</p>
21+
<p>I will detail each step below.</p>
22+
<section id="section_kr4_jjv_v2c">
23+
<title>Open the workspace</title>
24+
<p>Content Fusion allows you to create a workspace for each Git branch. The workspace is
25+
lightweight meaning that it is created instantly and with minimal resource overhead.
26+
To open it, select the branch and click the <uicontrol>Edit in workspace</uicontrol>
27+
button.</p>
28+
<p><image href="images/cf-edit-in-workspace.png" id="image_gh2_wjv_v2c" width="300px"
29+
/></p>
30+
</section>
31+
<section id="section_n2y_wjv_v2c">
32+
<title>Synchronize the workspace</title>
33+
<p>In most cases, your workspace is updated automatically when you open it. However, if
34+
your workspace has some stale changes (maybe from an old abandoned edit), you will
35+
have to manually synchronize it. You have two tools:</p>
36+
<p>
37+
<ol id="ol_xpz_5mv_v2c">
38+
<li>Use the <uicontrol>Discard all changes</uicontrol> action from the
39+
<uicontrol>Changes</uicontrol> side view if the existing changes are not
40+
relevant anymore:<p><image href="images/discard-all-action.png"
41+
id="image_p25_bnv_v2c" width="300px"/></p></li>
42+
<li><uicontrol>Pull</uicontrol> the incoming commits. This lets you bring in
43+
your workspace commits made by your collaborators.<p><image
44+
href="images/cf-pull-incomming-commits.png" id="image_v12_5nv_v2c"
45+
width="300px"/></p></li>
46+
</ol>
47+
</p>
48+
</section>
49+
<section id="section_erd_nnv_v2c">
50+
<title>Edit</title>
51+
<p>Use the workspace tools to work on your content. </p>
52+
</section>
53+
<section id="section_ljh_qnv_v2c">
54+
<title>Pull incoming commits</title>
55+
<p>While you were editing, your collaborators pushed some commits. Before you can commit
56+
your changes, you have to integrate theirs first. In rare cases, you might run into
57+
merge conflicts. To help you solve them, <xref
58+
href="https://www.oxygenxml.com/doc/versions/8.0/ug-content-fusion/topics/cf-projects-workspace-conflict-resolution.html"
59+
format="html" scope="external">Content Fusion has a dedicated merge
60+
tool</xref>:</p>
61+
<p><image href="images/merge-pull-incoming-commits-conflicts.png" id="image_wmf_g4v_v2c"
62+
width="300px"/></p>
63+
</section>
64+
<section id="section_lqg_k4v_v2c">
65+
<title>Validate</title>
66+
<p>Use the <uicontrol>Problems</uicontrol> view to check if your changes introduce any
67+
validation problem or a broken link</p>
68+
<p><image href="images/cf-problems-view.png" id="image_xz2_r4v_v2c" width="300px"/></p>
69+
</section>
70+
<section id="section_rms_34v_v2c">
71+
<title>Commit</title>
72+
<p>To make your changes available in the Git repository, you have to
73+
<uicontrol>Commit</uicontrol> them. Make sure to provide a descriptive commit
74+
message.</p>
75+
<p>
76+
<note id="note_dm1_w4v_v2c">In Content Fusion, when you commit changes from your
77+
workspace they are immediately available on the underlying branch.</note>
78+
</p>
79+
</section>
80+
</body>
81+
</topic>

‎git-tech-writers/images/cf-edit-in-workspace.png

5.32 KB
Loading

‎git-tech-writers/images/cf-problems-view.png

9.37 KB
Loading

‎git-tech-writers/images/cf-pull-incomming-commits.png

32.4 KB
Loading

‎git-tech-writers/images/discard-all-action.png

53.5 KB
Loading

‎git-tech-writers/images/merge-pull-incoming-commits-conflicts.png

110 KB
Loading

‎git-tech-writers/using_git_for_technical_writing.ditamap

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
<topicref href="disadvantages_of_using_git.dita"/>
88
<topicref href="resources_for_learning_git.dita"/>
99
<topicref href="git_client_applications.dita"/>
10-
<topicref href="editing_session_workflow.dita"/>
10+
<topicref href="editing_session_workflow.dita">
11+
<topicref href="cf_editing_session_workflow.dita"/>
12+
</topicref>
1113
<topicref href="git_validation.dita"/>
1214
<topicref href="common_workflows.dita">
1315
<topicref href="centralized_workflow.dita"/>
@@ -20,6 +22,6 @@
2022
<topicref href="handling_translations.dita"/>
2123
<topicref href="sharing_common_settings.dita"/>
2224
<topicref href="publishing_content_from_git.dita"/>
23-
<topicref href="tame-the-branch-chaos.dita"/>
25+
<topicref href="tame-the-branch-chaos.dita"/>
2426
</topicref>
2527
</map>

0 commit comments

Comments
 (0)