Skip to content

Commit 05f35ed

Browse files
authored
Update documentation
1 parent e1aa2d6 commit 05f35ed

19 files changed

+17
-17
lines changed

docs/workshops/1.1. preparation/1-setup-archi.md renamed to docs/5. workshops/5.1. preparation/1-setup-archi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 1.1.1. Setting up and configuring Archi and the plug-in
1+
# 5.1.1. Setting up and configuring Archi and the plug-in
22

33
## Installing Archi
44

docs/workshops/1.1. preparation/2-prepare-github.md renamed to docs/5. workshops/5.1. preparation/2-prepare-github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 1.1.2. Preparing your GitHub account to configure Archi integration
1+
# 5.1.2. Preparing your GitHub account to configure Archi integration
22

33
1. Log onto your GitHub Account at [GitHub.com](https://github.com) or create a GitHub account at [GitHub.com](https://github.com)
44
2. Please share your GitHub account name by emailing it to [email protected], so that we can add you to the NBility-Model GitHub organization.

docs/workshops/1.1. preparation/3-import-model-to-archi.md renamed to docs/5. workshops/5.1. preparation/3-import-model-to-archi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 1.1.3. Import the model from GitHub into Archi
1+
# 5.1.3. Import the model from GitHub into Archi
22

33
Once you have configured Archi and coArchi, and generated your Github Personal Access Token (PAT) you will be able to import the Nbility model into archi.
44

docs/workshops/archi-beginner/1-navigate-ui.md renamed to docs/5. workshops/5.2. archi-beginner/1-navigate-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Navigate the UI"
33
---
44

5-
# Navigating the user interface
5+
# 5.2.1. Navigating the user interface
66

77
1. In Archi, select [**Toggle Collaboration Workspace**] and [**Toggle Branches View**] from the **Collaboration** menu. The Workspace and Branch windows will be docked within Archi. Archi/coArchi supports repository branches.
88

docs/workshops/archi-beginner/2-refresh-model.md renamed to docs/5. workshops/5.2. archi-beginner/2-refresh-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Refresh model"
33
---
44

5-
# Refreshing the model
5+
# 5.2.2. Refreshing the model
66

77
**IMPORTANT: To ensure that the local repository remains synchronized with the upstream repository and to prevent overwriting any changes made since the last pull from the server, it is crucial to refresh the model from GitHub before applying any modifications.** Regular refreshs of the model not only maintain alignment with the upstream repository but also mitigate the risk of merge conflicts.
88

docs/workshops/archi-beginner/3-add-new-branch.md renamed to docs/5. workshops/5.2. archi-beginner/3-add-new-branch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Add new branch"
33
---
44

5-
# Adding a new branch
5+
# 5.2.3. Adding a new branch
66

77
To protect the integrity of the main branch and avoid overwriting updates from someone else, it is recommended to create a branch for each new piece of work. Branches could be named by feature_[**topic name**] or fix_[**topic name**]. Branches can be created either through the coArchi plugin or via Github.com.
88

docs/workshops/archi-beginner/4-switch-branch.md renamed to docs/5. workshops/5.2. archi-beginner/4-switch-branch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Switch branch"
33
---
44

5-
# Switching branches
5+
# 5.2.4. Switching branches
66

77
1. In archi, select [**Toggle Branches View**] from the **Collaboration** menu.
88
2. In archi, right click on the branch you like to switch to and click on [**Switch branch**].

docs/workshops/archi-beginner/5-commit-and-publish-change.md renamed to docs/5. workshops/5.2. archi-beginner/5-commit-and-publish-change.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Commit and publish changes"
33
---
44

5-
# Committing and publishing changes
5+
# 5.2.5. Committing and publishing changes
66

77
1. To commit your latest changes, select [**Commit changes**] from the **Collaboration** menu.
88

docs/workshops/archi-beginner/6-merge-change.md renamed to docs/5. workshops/5.2. archi-beginner/6-merge-change.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Merge change"
33
---
44

5-
# Creating a pull request review and merging topic branch
5+
# 5.2.6. Creating a pull request review and merging topic branch
66

77
On regular intervals all committed and published branches need to be merged into the main branch which will trickle down into all subsequent branches.
88

docs/workshops/archi-beginner/7-export-xml.md renamed to docs/5. workshops/5.2. archi-beginner/7-export-xml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Export to XML"
33
---
44

5-
# Exporting a model to an Open Exchange XML file
5+
# 5.2.7. Exporting a model to an Open Exchange XML file
66

77
1. Open Archi on your local machine and select the architecture repository which you would like to export. For the purpose of this example, we choose Nbility-business-capabilities-EN. See image below.
88

0 commit comments

Comments
 (0)