diff --git a/docs/workshops/1.1. preparation/1-setup-archi.md b/docs/5. workshops/5.1. preparation/1-setup-archi.md similarity index 94% rename from docs/workshops/1.1. preparation/1-setup-archi.md rename to docs/5. workshops/5.1. preparation/1-setup-archi.md index 386a716..fbb6d62 100644 --- a/docs/workshops/1.1. preparation/1-setup-archi.md +++ b/docs/5. workshops/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/docs/workshops/1.1. preparation/2-prepare-github.md b/docs/5. workshops/5.1. preparation/2-prepare-github.md similarity index 96% rename from docs/workshops/1.1. preparation/2-prepare-github.md rename to docs/5. workshops/5.1. preparation/2-prepare-github.md index f0e9ac5..f39a6cb 100644 --- a/docs/workshops/1.1. preparation/2-prepare-github.md +++ b/docs/5. workshops/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 OSPO@alliander.com, so that we can add you to the NBility-Model GitHub organization. diff --git a/docs/workshops/1.1. preparation/3-import-model-to-archi.md b/docs/5. workshops/5.1. preparation/3-import-model-to-archi.md similarity index 96% rename from docs/workshops/1.1. preparation/3-import-model-to-archi.md rename to docs/5. workshops/5.1. preparation/3-import-model-to-archi.md index 65fc52a..3aa53c1 100644 --- a/docs/workshops/1.1. preparation/3-import-model-to-archi.md +++ b/docs/5. workshops/5.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/docs/workshops/archi-beginner/1-navigate-ui.md b/docs/5. workshops/5.2. archi-beginner/1-navigate-ui.md similarity index 92% rename from docs/workshops/archi-beginner/1-navigate-ui.md rename to docs/5. workshops/5.2. archi-beginner/1-navigate-ui.md index 5621458..4827670 100644 --- a/docs/workshops/archi-beginner/1-navigate-ui.md +++ b/docs/5. workshops/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/docs/workshops/archi-beginner/2-refresh-model.md b/docs/5. workshops/5.2. archi-beginner/2-refresh-model.md similarity index 96% rename from docs/workshops/archi-beginner/2-refresh-model.md rename to docs/5. workshops/5.2. archi-beginner/2-refresh-model.md index e76c18a..fd324ea 100644 --- a/docs/workshops/archi-beginner/2-refresh-model.md +++ b/docs/5. workshops/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/docs/workshops/archi-beginner/3-add-new-branch.md b/docs/5. workshops/5.2. archi-beginner/3-add-new-branch.md similarity index 98% rename from docs/workshops/archi-beginner/3-add-new-branch.md rename to docs/5. workshops/5.2. archi-beginner/3-add-new-branch.md index d630fda..d762d4e 100644 --- a/docs/workshops/archi-beginner/3-add-new-branch.md +++ b/docs/5. workshops/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/docs/workshops/archi-beginner/4-switch-branch.md b/docs/5. workshops/5.2. archi-beginner/4-switch-branch.md similarity index 90% rename from docs/workshops/archi-beginner/4-switch-branch.md rename to docs/5. workshops/5.2. archi-beginner/4-switch-branch.md index ae30628..bb6e8f0 100644 --- a/docs/workshops/archi-beginner/4-switch-branch.md +++ b/docs/5. workshops/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/docs/workshops/archi-beginner/5-commit-and-publish-change.md b/docs/5. workshops/5.2. archi-beginner/5-commit-and-publish-change.md similarity index 96% rename from docs/workshops/archi-beginner/5-commit-and-publish-change.md rename to docs/5. workshops/5.2. archi-beginner/5-commit-and-publish-change.md index ffb9099..11758ad 100644 --- a/docs/workshops/archi-beginner/5-commit-and-publish-change.md +++ b/docs/5. workshops/5.2. archi-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/docs/workshops/archi-beginner/6-merge-change.md b/docs/5. workshops/5.2. archi-beginner/6-merge-change.md similarity index 94% rename from docs/workshops/archi-beginner/6-merge-change.md rename to docs/5. workshops/5.2. archi-beginner/6-merge-change.md index 11febac..c8dc568 100644 --- a/docs/workshops/archi-beginner/6-merge-change.md +++ b/docs/5. workshops/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/docs/workshops/archi-beginner/7-export-xml.md b/docs/5. workshops/5.2. archi-beginner/7-export-xml.md similarity index 92% rename from docs/workshops/archi-beginner/7-export-xml.md rename to docs/5. workshops/5.2. archi-beginner/7-export-xml.md index 28edb8f..d157dd3 100644 --- a/docs/workshops/archi-beginner/7-export-xml.md +++ b/docs/5. workshops/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/docs/workshops/archi-beginner/8-export-csv.md b/docs/5. workshops/5.2. archi-beginner/8-export-csv.md similarity index 93% rename from docs/workshops/archi-beginner/8-export-csv.md rename to docs/5. workshops/5.2. archi-beginner/8-export-csv.md index fe2fa76..082acb8 100644 --- a/docs/workshops/archi-beginner/8-export-csv.md +++ b/docs/5. workshops/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/docs/workshops/archi-beginner/9-generate-pdf-docx-pptx.md b/docs/5. workshops/5.2. archi-beginner/9-generate-pdf-docx-pptx.md similarity index 86% rename from docs/workshops/archi-beginner/9-generate-pdf-docx-pptx.md rename to docs/5. workshops/5.2. archi-beginner/9-generate-pdf-docx-pptx.md index ad2cde7..c2633d1 100644 --- a/docs/workshops/archi-beginner/9-generate-pdf-docx-pptx.md +++ b/docs/5. workshops/5.2. archi-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 b/docs/5. workshops/5.3. import-archi-in-bizzdesign.md similarity index 100% rename from docs/workshops/import-archi-in-bizzdesign.md rename to docs/5. workshops/5.3. import-archi-in-bizzdesign.md diff --git a/docs/workshops/index.md b/docs/5. workshops/index.md similarity index 100% rename from docs/workshops/index.md rename to docs/5. workshops/index.md diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index 8ffccd9..7f404eb 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -1,4 +1,4 @@ -# Code of Conduct +# 2. Code of Conduct