Update documentation

NBility-Model · Feb 20, 2025 · 05f35ed · 05f35ed
1 parent e1aa2d6
commit 05f35ed
Show file tree

Hide file tree

Showing 19 changed files with 17 additions and 17 deletions.
diff --git a/...rkshops/1.1. preparation/1-setup-archi.md → ...rkshops/5.1. preparation/1-setup-archi.md b/...rkshops/1.1. preparation/1-setup-archi.md → ...rkshops/5.1. preparation/1-setup-archi.md
@@ -1,4 +1,4 @@
-# 1.1.1. Setting up and configuring Archi and the plug-in
+# 5.1.1. Setting up and configuring Archi and the plug-in
 
 ## Installing Archi
 

diff --git a/...hops/1.1. preparation/2-prepare-github.md → ...hops/5.1. preparation/2-prepare-github.md b/...hops/1.1. preparation/2-prepare-github.md → ...hops/5.1. preparation/2-prepare-github.md
@@ -1,4 +1,4 @@
-# 1.1.2. Preparing your GitHub account to configure Archi integration
+# 5.1.2. Preparing your GitHub account to configure Archi integration
 
 1. Log onto your GitHub Account at [GitHub.com](https://github.com) or create a GitHub account at [GitHub.com](https://github.com)
 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.

diff --git a/...1. preparation/3-import-model-to-archi.md → ...1. preparation/3-import-model-to-archi.md b/...1. preparation/3-import-model-to-archi.md → ...1. preparation/3-import-model-to-archi.md
@@ -1,4 +1,4 @@
-# 1.1.3. Import the model from GitHub into Archi
+# 5.1.3. Import the model from GitHub into Archi
 
 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.
 

diff --git a/...workshops/archi-beginner/1-navigate-ui.md → ...hops/5.2. archi-beginner/1-navigate-ui.md b/...workshops/archi-beginner/1-navigate-ui.md → ...hops/5.2. archi-beginner/1-navigate-ui.md
@@ -2,7 +2,7 @@
 title: "Navigate the UI"
 ---
 
-# Navigating the user interface
+# 5.2.1. Navigating the user interface
 
 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.
 

diff --git a/...rkshops/archi-beginner/2-refresh-model.md → ...ps/5.2. archi-beginner/2-refresh-model.md b/...rkshops/archi-beginner/2-refresh-model.md → ...ps/5.2. archi-beginner/2-refresh-model.md
@@ -2,7 +2,7 @@
 title: "Refresh model"
 ---
 
-# Refreshing the model
+# 5.2.2. Refreshing the model
 
 **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.
 

diff --git a/...kshops/archi-beginner/3-add-new-branch.md → ...s/5.2. archi-beginner/3-add-new-branch.md b/...kshops/archi-beginner/3-add-new-branch.md → ...s/5.2. archi-beginner/3-add-new-branch.md
@@ -2,7 +2,7 @@
 title: "Add new branch"
 ---
 
-# Adding a new branch
+# 5.2.3. Adding a new branch
 
 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.
 

diff --git a/...rkshops/archi-beginner/4-switch-branch.md → ...ps/5.2. archi-beginner/4-switch-branch.md b/...rkshops/archi-beginner/4-switch-branch.md → ...ps/5.2. archi-beginner/4-switch-branch.md
@@ -2,7 +2,7 @@
 title: "Switch branch"
 ---
 
-# Switching branches
+# 5.2.4. Switching branches
 
 1. In archi, select [**Toggle Branches View**] from the **Collaboration** menu.
 2. In archi, right click on the branch you like to switch to and click on [**Switch branch**].

diff --git a/...i-beginner/5-commit-and-publish-change.md → ...i-beginner/5-commit-and-publish-change.md b/...i-beginner/5-commit-and-publish-change.md → ...i-beginner/5-commit-and-publish-change.md
@@ -2,7 +2,7 @@
 title: "Commit and publish changes"
 ---
 
-# Committing and publishing changes
+# 5.2.5. Committing and publishing changes
 
 1. To commit your latest changes, select [**Commit changes**] from the **Collaboration** menu. 
 

diff --git a/...orkshops/archi-beginner/6-merge-change.md → ...ops/5.2. archi-beginner/6-merge-change.md b/...orkshops/archi-beginner/6-merge-change.md → ...ops/5.2. archi-beginner/6-merge-change.md
@@ -2,7 +2,7 @@
 title: "Merge change"
 ---
 
-# Creating a pull request review and merging topic branch
+# 5.2.6. Creating a pull request review and merging topic branch
 
 On regular intervals all committed and published branches need to be merged into the main branch which will trickle down into all subsequent branches.
 

diff --git a/.../workshops/archi-beginner/7-export-xml.md → ...shops/5.2. archi-beginner/7-export-xml.md b/.../workshops/archi-beginner/7-export-xml.md → ...shops/5.2. archi-beginner/7-export-xml.md
@@ -2,7 +2,7 @@
 title: "Export to XML"
 ---
 
-# Exporting a model to an Open Exchange XML file
+# 5.2.7. Exporting a model to an Open Exchange XML file
 
 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.
 

diff --git a/.../workshops/archi-beginner/8-export-csv.md → ...shops/5.2. archi-beginner/8-export-csv.md b/.../workshops/archi-beginner/8-export-csv.md → ...shops/5.2. archi-beginner/8-export-csv.md
@@ -2,7 +2,7 @@
 title: "Export to CSV"
 ---
 
-# Exporting a model to an Open Exchange CSV file
+# 5.2.8. Exporting a model to an Open Exchange CSV file
 
 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.
 

diff --git a/...rchi-beginner/9-generate-pdf-docx-pptx.md → ...rchi-beginner/9-generate-pdf-docx-pptx.md b/...rchi-beginner/9-generate-pdf-docx-pptx.md → ...rchi-beginner/9-generate-pdf-docx-pptx.md
@@ -2,7 +2,7 @@
 title: "Generate model in PDF, Word, Powerpoint"
 ---
 
-# Generating a model in PDF, MS Word or MS Powerpoint
+# 5.2.9. Generating a model in PDF, MS Word or MS Powerpoint
 
 1. In archi, select [Report] and then [Jasper] in the File menu.
 

diff --git a/docs/workshops/import-archi-in-bizzdesign.md → ...kshops/5.3. import-archi-in-bizzdesign.md b/docs/workshops/import-archi-in-bizzdesign.md → ...kshops/5.3. import-archi-in-bizzdesign.md
diff --git a/docs/workshops/index.md → docs/5. workshops/index.md b/docs/workshops/index.md → docs/5. workshops/index.md
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
@@ -1,4 +1,4 @@
-# Code of Conduct
+# 2. Code of Conduct
 
 <!--
 SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing to NBility-Model
+# 1. Contributing to NBility-Model
 
 Thank you for considering contributing to the NBility-Model project! We appreciate your interest and look forward to your contributions. Follow the guidelines below to ensure a smooth and collaborative experience.
 

diff --git a/docs/GUIDELINES.md b/docs/GUIDELINES.md
@@ -1,4 +1,4 @@
-# NBility model design guidelines
+# 3. NBility model design guidelines
 
 NBility model adheres to generic design rules. Every adjustment and/or expansion should conform to these rules. These guidelines consist of:
 

diff --git a/docs/PROJECT_GOVERNANCE.md b/docs/PROJECT_GOVERNANCE.md
@@ -1,4 +1,4 @@
-# Project Governance
+# 4. Project Governance
 
 The basic principle is that decisions are based on consensus. If this decision making process takes too long or a decision is required, the project committee has the authority to make a decision.
 

diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md
@@ -1,4 +1,4 @@
-# Getting Help
+# 6. Getting Help
 
 There are a few ways to connect with the `<YOUR_PROJECT_NAME>` project: