From 44eb6a4bc2d88bab6f135c2a4334e7857d87d76c Mon Sep 17 00:00:00 2001 From: Macario Gianpaolo Date: Mon, 18 Sep 2023 13:20:24 +0200 Subject: [PATCH 01/24] docs/howto: Create howto-install-eclipse-capella.md --- docs/howto/howto-install-eclipse-capella.md | 33 +++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/howto/howto-install-eclipse-capella.md diff --git a/docs/howto/howto-install-eclipse-capella.md b/docs/howto/howto-install-eclipse-capella.md new file mode 100644 index 0000000..2cc3661 --- /dev/null +++ b/docs/howto/howto-install-eclipse-capella.md @@ -0,0 +1,33 @@ +# HOWTO Install Eclipse Capella + +## Executive Summary + +This document explains how to install [Eclipse Capella™](https://www.eclipse.org/capella/) - an Open Source solution for Model-Based Systems Engineering - and use it for the ARNEIS project. + +## Introduction Eclipse Capella™ + +Eclipse Capella™ is a comprehensive, extensible and field-proven MBSE tool and method +to successfully design systems architecture. + + + +### References + +* + +## Step-by-step instructions + +Open and download the version of Capella suitable for your host HW and OS. +In my case (HW2457) this is "CAPELLA 6.1 FOR WINDOWS 64-BIT". + +![image](https://github.com/B-AROL-O/ARNEIS/assets/75182/871df363-b8a1-4247-be3e-1ad9a1774ad6) + +You may select another mirror if you like, otherwise click "Download". + +![image](https://github.com/B-AROL-O/ARNEIS/assets/75182/7f1ecce0-cb6e-4aa7-9387-0bcb2abe23de) + +You may also support the Eclipse Community by donating some money. + +TODO + + From 4f74db5ea068513a9085aefafa4deafcb1856da3 Mon Sep 17 00:00:00 2001 From: Macario Gianpaolo Date: Mon, 18 Sep 2023 16:02:39 +0200 Subject: [PATCH 02/24] Fix a few markdown errors --- docs/howto/howto-configure-arneis-readthedocs-io.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/howto/howto-configure-arneis-readthedocs-io.md b/docs/howto/howto-configure-arneis-readthedocs-io.md index 5ce8711..1a78be0 100644 --- a/docs/howto/howto-configure-arneis-readthedocs-io.md +++ b/docs/howto/howto-configure-arneis-readthedocs-io.md @@ -219,6 +219,7 @@ Type "HOWTO" into the "Search docs" input field and verify that the Markdown pag References: + * * [Preview Documentation from Pull Requests](https://docs.readthedocs.io/page/guides/autobuild-docs-for-pull-requests.html) @@ -228,7 +229,7 @@ In order to enable the Pull Request preview feature you should execute the follo ![2022-04-21-2157-howto-rtd-admin.png](../images/2022-04-21-2157-howto-rtd-admin.png) -1. In `Advanced Settings` select **Build pull requests for this project** +2. In `Advanced Settings` select **Build pull requests for this project** ![2022-04-21-2157-howto-rtd-advsetting.png](../images/2022-04-21-2157-howto-rtd-advsetting.png) From d747de5d363f61a17daada340dcfbc049ceb879b Mon Sep 17 00:00:00 2001 From: Macario Gianpaolo Date: Mon, 18 Sep 2023 16:02:54 +0200 Subject: [PATCH 03/24] Expand introduction --- docs/howto/howto-install-eclipse-capella.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/howto/howto-install-eclipse-capella.md b/docs/howto/howto-install-eclipse-capella.md index 2cc3661..6993168 100644 --- a/docs/howto/howto-install-eclipse-capella.md +++ b/docs/howto/howto-install-eclipse-capella.md @@ -4,10 +4,9 @@ This document explains how to install [Eclipse Capella™](https://www.eclipse.org/capella/) - an Open Source solution for Model-Based Systems Engineering - and use it for the ARNEIS project. -## Introduction Eclipse Capella™ +## Introduction to Eclipse Capella™ -Eclipse Capella™ is a comprehensive, extensible and field-proven MBSE tool and method -to successfully design systems architecture. +Eclipse Capella™ is a comprehensive, extensible and field-proven MBSE tool and method to successfully design systems architecture. From ecb68058d9f837727fef44dd09e4bb35fb04714f Mon Sep 17 00:00:00 2001 From: Macario Gianpaolo Date: Tue, 19 Sep 2023 07:48:50 +0200 Subject: [PATCH 04/24] index.rst: Add link to howto-install-eclipse-capella --- docs/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 8f83bd9..5656dcd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -123,6 +123,7 @@ gone through during the project realization. * :doc:`howto/howto-configure-arneis-readthedocs-io` * :doc:`howto/howto-create-landing-page-netlify` * :doc:`howto/howto-configure-google-analytics` + * :doc:`howto/howto-install-eclipse-capella` * :doc:`howto/howto-use-mermaid-graphic-tool` * **Learning AI and related tools**: @@ -150,6 +151,7 @@ gone through during the project realization. howto/howto-configure-arneis-readthedocs-io howto/howto-create-landing-page-netlify howto/howto-configure-google-analytics + howto/howto-install-eclipse-capella howto/howto-use-mermaid-graphic-tool howto/howto-install-depthai-on-rpi From 8438816bd8334250b4fddb8993673128ea826b89 Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Sat, 23 Sep 2023 12:46:27 +0200 Subject: [PATCH 05/24] arneis-social-media.md: Add date and summary to all LinkedIn posts --- docs/arneis-social-media.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/arneis-social-media.md b/docs/arneis-social-media.md index 872a564..878fdd5 100644 --- a/docs/arneis-social-media.md +++ b/docs/arneis-social-media.md @@ -136,22 +136,22 @@ Date | Coverage | Summary **NOTE**: Search for `#ARNEIS` and `#OAKDLiteContest` to find other posts on the same subject: -1. -2. -3. -4. -5. -6. -7. -8. -9. -10. -11. -12. -13. -14. -15. -16. +6. 2022-01-17: Gianluca on ARNEIS project journal - dev-cw02: +7. 2022-01-24: Gianluca on ARNEIS project journal - dev-cw03: +8. 2022-02-02: Gianluca on ARNEIS project journal - dev-cw04: +9. 2022-02-07: Gianluca on ARNEIS project journal - dev-cw05: +10. 2022-02-28: Gianluca on ARNEIS project journal - dev-cw08: +1. 2022-03-07: Gianpaolo on ARNEIS project journal - dev-cw09: +2. 2022-03-17: Using AI & LEGO to Recognize, Sort, and Package - OpenCV Weekly - Event by OpenCV: +3. 2022-04-04: Gianpaolo on ARNEIS project journal - dev-cw13: +5. 2022-04-05: Comment to post by Satya Mallick: +11. 2022-04-12: Article by AROL S.p.A. on LinkedIn: +12. 2022-04-12: Post by AROL Sp.A. with link to article: +13. 2022-04-13: Gianpaolo repost of article by AROL S.p.A.: +14. 2022-04-14: Pietro repost of article by AROL S.p.A.: +15. 2022-04-15: Post by Alessandro soliciting votes for "Team B-AROL-O" at #OAKDLiteContest: +16. 2022-04-16: Serena Bisacca repost of post by Alessandro: +17. 2022-04-15: Gianpaolo repost of post by Alessandro: ### YouTube From 86d671b5b8d5d6ed815e0d906caa2b49cf9ea1ff Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Sat, 23 Sep 2023 12:48:48 +0200 Subject: [PATCH 06/24] arneis-social-media.md: Renumber items in section "LinkedIn" --- docs/arneis-social-media.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/arneis-social-media.md b/docs/arneis-social-media.md index 878fdd5..7b5a09e 100644 --- a/docs/arneis-social-media.md +++ b/docs/arneis-social-media.md @@ -134,24 +134,24 @@ Date | Coverage | Summary ### LinkedIn -**NOTE**: Search for `#ARNEIS` and `#OAKDLiteContest` to find other posts on the same subject: - -6. 2022-01-17: Gianluca on ARNEIS project journal - dev-cw02: -7. 2022-01-24: Gianluca on ARNEIS project journal - dev-cw03: -8. 2022-02-02: Gianluca on ARNEIS project journal - dev-cw04: -9. 2022-02-07: Gianluca on ARNEIS project journal - dev-cw05: -10. 2022-02-28: Gianluca on ARNEIS project journal - dev-cw08: -1. 2022-03-07: Gianpaolo on ARNEIS project journal - dev-cw09: -2. 2022-03-17: Using AI & LEGO to Recognize, Sort, and Package - OpenCV Weekly - Event by OpenCV: -3. 2022-04-04: Gianpaolo on ARNEIS project journal - dev-cw13: -5. 2022-04-05: Comment to post by Satya Mallick: -11. 2022-04-12: Article by AROL S.p.A. on LinkedIn: -12. 2022-04-12: Post by AROL Sp.A. with link to article: -13. 2022-04-13: Gianpaolo repost of article by AROL S.p.A.: -14. 2022-04-14: Pietro repost of article by AROL S.p.A.: -15. 2022-04-15: Post by Alessandro soliciting votes for "Team B-AROL-O" at #OAKDLiteContest: -16. 2022-04-16: Serena Bisacca repost of post by Alessandro: -17. 2022-04-15: Gianpaolo repost of post by Alessandro: +**NOTE**: Search for `#ARNEIS` and/or `#OAKDLiteContest` to find other posts on the same subject: + +1. 2022-01-17: Gianluca on ARNEIS project journal - dev-cw02: +2. 2022-01-24: Gianluca on ARNEIS project journal - dev-cw03: +3. 2022-02-02: Gianluca on ARNEIS project journal - dev-cw04: +4. 2022-02-07: Gianluca on ARNEIS project journal - dev-cw05: +5. 2022-02-28: Gianluca on ARNEIS project journal - dev-cw08: +6. 2022-03-07: Gianpaolo on ARNEIS project journal - dev-cw09: +7. 2022-03-17: Using AI & LEGO to Recognize, Sort, and Package - OpenCV Weekly - Event by OpenCV: +8. 2022-04-04: Gianpaolo on ARNEIS project journal - dev-cw13: +9. 2022-04-05: Comment to post by Satya Mallick: +10. 2022-04-12: Article by AROL S.p.A. on LinkedIn: +11. 2022-04-12: Post by AROL Sp.A. with link to article: +12. 2022-04-13: Gianpaolo repost of article by AROL S.p.A.: +13. 2022-04-14: Pietro repost of article by AROL S.p.A.: +14. 2022-04-15: Post by Alessandro soliciting votes for "Team B-AROL-O" at #OAKDLiteContest: +15. 2022-04-16: Serena Bisacca repost of post by Alessandro: +16. 2022-04-15: Gianpaolo repost of post by Alessandro: ### YouTube From 376ace11bf14b12f6b423ccef1f97c972097bac4 Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Sun, 1 Oct 2023 23:38:39 +0200 Subject: [PATCH 07/24] Create CONTRIBUTING.md --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9656971 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# CONTRIBUTING.md + +TODO + + \ No newline at end of file From 02d279e7d48624ddbe4944ddea5e346b907d0140 Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Mon, 2 Oct 2023 22:06:12 +0200 Subject: [PATCH 08/24] Add CONTRIBUTING.md Generated by https://generator.contributing.md/ --- CONTRIBUTING.md | 160 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 157 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9656971..a8a7813 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,159 @@ -# CONTRIBUTING.md + +# Contributing to ARNEIS -TODO +First off, thanks for taking the time to contribute! ❤️ - \ No newline at end of file +All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 + +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> - Star the project +> - Tweet about it +> - Refer this project in your project's readme +> - Mention the project at local meetups and tell your friends/colleagues + + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [I Have a Question](#i-have-a-question) +- [I Want To Contribute](#i-want-to-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Enhancements](#suggesting-enhancements) + - [Your First Code Contribution](#your-first-code-contribution) + - [Improving The Documentation](#improving-the-documentation) +- [Styleguides](#styleguides) + - [Commit Messages](#commit-messages) +- [Join The Project Team](#join-the-project-team) + + +## Code of Conduct + +This project and everyone participating in it is governed by the +[ARNEIS Code of Conduct](https://github.com/B-AROL-O/ARNEISblob/master/CODE_OF_CONDUCT.md). +By participating, you are expected to uphold this code. Please report unacceptable behavior +to . + + +## I Have a Question + +> If you want to ask a question, we assume that you have read the available [Documentation](https://arneis.readthedocs.io/). + +Before you ask a question, it is best to search for existing [Issues](https://github.com/B-AROL-O/ARNEIS/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. + +If you then still feel the need to ask a question and need clarification, we recommend the following: + +- Open an [Issue](https://github.com/B-AROL-O/ARNEIS/issues/new). +- Provide as much context as you can about what you're running into. +- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. + +We will then take care of the issue as soon as possible. + + + +## I Want To Contribute + +> ### Legal Notice +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. + +### Reporting Bugs + + +#### Before Submitting a Bug Report + +A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. + +- Make sure that you are using the latest version. +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://arneis.readthedocs.io/). If you are looking for support, you might want to check [this section](#i-have-a-question)). +- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/B-AROL-O/ARNEISissues?q=label%3Abug). +- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. +- Collect information about the bug: + - Stack trace (Traceback) + - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) + - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. + - Possibly your input and the output + - Can you reliably reproduce the issue? And can you also reproduce it with older versions? + + +#### How Do I Submit a Good Bug Report? + +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to . + + +We use GitHub issues to track bugs and errors. If you run into an issue with the project: + +- Open an [Issue](https://github.com/B-AROL-O/ARNEIS/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) +- Explain the behavior you would expect and the actual behavior. +- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. +- Provide the information you collected in the previous section. + +Once it's filed: + +- The project team will label the issue accordingly. +- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced. +- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution). + + + + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for ARNEIS, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. + + +#### Before Submitting an Enhancement + +- Make sure that you are using the latest version. +- Read the [documentation](https://arneis.readthedocs.io/) carefully and find out if the functionality is already covered, maybe by an individual configuration. +- Perform a [search](https://github.com/B-AROL-O/ARNEIS/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. + + +#### How Do I Submit a Good Enhancement Suggestion? + +Enhancement suggestions are tracked as [GitHub issues](https://github.com/B-AROL-O/ARNEIS/issues). + +- Use a **clear and descriptive title** for the issue to identify the suggestion. +- Provide a **step-by-step description of the suggested enhancement** in as many details as possible. +- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. +- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. +- **Explain why this enhancement would be useful** to most ARNEIS users. You may also want to point out the other projects that solved it better and which could serve as inspiration. + + + +### Your First Code Contribution + + +### Improving The Documentation + + +## Styleguides +### Commit Messages + + +## Join The Project Team + + + +## Attribution +This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! From b18ef4df85889b255da6f6ef1f9b3a612cfceaf4 Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Mon, 2 Oct 2023 22:06:47 +0200 Subject: [PATCH 09/24] Add CODE_OF_CONDUCT.md Generated by https://generator.contributing.md/ --- CODE_OF_CONDUCT.md | 70 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d213ba4 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,70 @@ +# Code of Conduct - ARNEIS + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, or to ban +temporarily or permanently any contributor for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at . +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version +[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and +[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), +and was generated by [contributing-gen](https://github.com/bttger/contributing-gen). \ No newline at end of file From eec29572728887ce2d8a3e457ce8ca7eeb01812b Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Mon, 2 Oct 2023 22:15:49 +0200 Subject: [PATCH 10/24] Fix markdownlint errors --- CODE_OF_CONDUCT.md | 4 +- CONTRIBUTING.md | 95 ++++++++++++++++++++++++---------------------- 2 files changed, 52 insertions(+), 47 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index d213ba4..59a1197 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -67,4 +67,6 @@ reporter of any incident. This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version [1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and [2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), -and was generated by [contributing-gen](https://github.com/bttger/contributing-gen). \ No newline at end of file +and was generated by [contributing-gen](https://github.com/bttger/contributing-gen). + + \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a8a7813..663f67f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,25 +6,25 @@ First off, thanks for taking the time to contribute! ❤️ All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: -> - Star the project -> - Tweet about it -> - Refer this project in your project's readme -> - Mention the project at local meetups and tell your friends/colleagues +> +> * Star the project +> * Tweet about it +> * Refer this project in your project's readme +> * Mention the project at local meetups and tell your friends/colleagues ## Table of Contents -- [Code of Conduct](#code-of-conduct) -- [I Have a Question](#i-have-a-question) -- [I Want To Contribute](#i-want-to-contribute) - - [Reporting Bugs](#reporting-bugs) - - [Suggesting Enhancements](#suggesting-enhancements) - - [Your First Code Contribution](#your-first-code-contribution) - - [Improving The Documentation](#improving-the-documentation) -- [Styleguides](#styleguides) - - [Commit Messages](#commit-messages) -- [Join The Project Team](#join-the-project-team) - +* [Code of Conduct](#code-of-conduct) +* [I Have a Question](#i-have-a-question) +* [I Want To Contribute](#i-want-to-contribute) + * [Reporting Bugs](#reporting-bugs) + * [Suggesting Enhancements](#suggesting-enhancements) + * [Your First Code Contribution](#your-first-code-contribution) + * [Improving The Documentation](#improving-the-documentation) +* [Styleguides](#styleguides) + * [Commit Messages](#commit-messages) +* [Join The Project Team](#join-the-project-team) ## Code of Conduct @@ -33,7 +33,6 @@ This project and everyone participating in it is governed by the By participating, you are expected to uphold this code. Please report unacceptable behavior to . - ## I Have a Question > If you want to ask a question, we assume that you have read the available [Documentation](https://arneis.readthedocs.io/). @@ -42,9 +41,9 @@ Before you ask a question, it is best to search for existing [Issues](https://gi If you then still feel the need to ask a question and need clarification, we recommend the following: -- Open an [Issue](https://github.com/B-AROL-O/ARNEIS/issues/new). -- Provide as much context as you can about what you're running into. -- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. +* Open an [Issue](https://github.com/B-AROL-O/ARNEIS/issues/new). +* Provide as much context as you can about what you're running into. +* Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. We will then take care of the issue as soon as possible. @@ -66,6 +65,7 @@ Depending on how large the project is, you may want to outsource the questioning ## I Want To Contribute > ### Legal Notice +> > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. ### Reporting Bugs @@ -75,16 +75,16 @@ Depending on how large the project is, you may want to outsource the questioning A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. -- Make sure that you are using the latest version. -- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://arneis.readthedocs.io/). If you are looking for support, you might want to check [this section](#i-have-a-question)). -- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/B-AROL-O/ARNEISissues?q=label%3Abug). -- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. -- Collect information about the bug: - - Stack trace (Traceback) - - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) - - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. - - Possibly your input and the output - - Can you reliably reproduce the issue? And can you also reproduce it with older versions? +* Make sure that you are using the latest version. +* Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://arneis.readthedocs.io/). If you are looking for support, you might want to check [this section](#i-have-a-question)). +* To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/B-AROL-O/ARNEISissues?q=label%3Abug). +* Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. +* Collect information about the bug: + * Stack trace (Traceback) + * OS, Platform and Version (Windows, Linux, macOS, x86, ARM) + * Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. + * Possibly your input and the output + * Can you reliably reproduce the issue? And can you also reproduce it with older versions? #### How Do I Submit a Good Bug Report? @@ -94,20 +94,19 @@ A good bug report shouldn't leave others needing to chase you up for more inform We use GitHub issues to track bugs and errors. If you run into an issue with the project: -- Open an [Issue](https://github.com/B-AROL-O/ARNEIS/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) -- Explain the behavior you would expect and the actual behavior. -- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. -- Provide the information you collected in the previous section. +* Open an [Issue](https://github.com/B-AROL-O/ARNEIS/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) +* Explain the behavior you would expect and the actual behavior. +* Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. +* Provide the information you collected in the previous section. Once it's filed: -- The project team will label the issue accordingly. -- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced. -- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution). +* The project team will label the issue accordingly. +* A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced. +* If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution). - ### Suggesting Enhancements This section guides you through submitting an enhancement suggestion for ARNEIS, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. @@ -115,21 +114,21 @@ This section guides you through submitting an enhancement suggestion for ARNEIS, #### Before Submitting an Enhancement -- Make sure that you are using the latest version. -- Read the [documentation](https://arneis.readthedocs.io/) carefully and find out if the functionality is already covered, maybe by an individual configuration. -- Perform a [search](https://github.com/B-AROL-O/ARNEIS/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. -- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. +* Make sure that you are using the latest version. +* Read the [documentation](https://arneis.readthedocs.io/) carefully and find out if the functionality is already covered, maybe by an individual configuration. +* Perform a [search](https://github.com/B-AROL-O/ARNEIS/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +* Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. #### How Do I Submit a Good Enhancement Suggestion? Enhancement suggestions are tracked as [GitHub issues](https://github.com/B-AROL-O/ARNEIS/issues). -- Use a **clear and descriptive title** for the issue to identify the suggestion. -- Provide a **step-by-step description of the suggested enhancement** in as many details as possible. -- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. -- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. -- **Explain why this enhancement would be useful** to most ARNEIS users. You may also want to point out the other projects that solved it better and which could serve as inspiration. +* Use a **clear and descriptive title** for the issue to identify the suggestion. +* Provide a **step-by-step description of the suggested enhancement** in as many details as possible. +* **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. +* You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. +* **Explain why this enhancement would be useful** to most ARNEIS users. You may also want to point out the other projects that solved it better and which could serve as inspiration. @@ -146,6 +145,7 @@ Updating, improving and correcting the documentation --> ## Styleguides + ### Commit Messages ## Attribution + This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! + + \ No newline at end of file From 40b93db4bbedda76e15a476c7dc3cb9786afe65d Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Mon, 2 Oct 2023 22:19:33 +0200 Subject: [PATCH 11/24] Fix textlint errors --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 663f67f..6b085d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents * [Suggesting Enhancements](#suggesting-enhancements) * [Your First Code Contribution](#your-first-code-contribution) * [Improving The Documentation](#improving-the-documentation) -* [Styleguides](#styleguides) +* [Style guides](#style-guides) * [Commit Messages](#commit-messages) * [Join The Project Team](#join-the-project-team) @@ -144,7 +144,7 @@ Updating, improving and correcting the documentation --> -## Styleguides +## Style guides ### Commit Messages +* You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. + You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. * **Explain why this enhancement would be useful** to most ARNEIS users. You may also want to point out the other projects that solved it better and which could serve as inspiration. From 77532f2453cf7aee5ed1781d5520a337cb01d5c4 Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Sat, 14 Oct 2023 12:14:22 +0000 Subject: [PATCH 14/24] Add .devcontainer/devcontainer.json Signed-off-by: Gianpaolo Macario --- .devcontainer/devcontainer.json | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..b332f39 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,22 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu +{ + "name": "Ubuntu", + // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile + "image": "mcr.microsoft.com/devcontainers/base:jammy" + + // Features to add to the dev container. More info: https://containers.dev/features. + // "features": {}, + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "uname -a", + + // Configure tool-specific properties. + // "customizations": {}, + + // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. + // "remoteUser": "root" +} From 6957b94e5402ea967dab2346fda280137677f0e2 Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Sun, 15 Oct 2023 07:33:27 +0200 Subject: [PATCH 15/24] .github/linters: Add .eslintrc.yml Copied from https://github.com/super-linter/super-linter/tree/main/TEMPLATES --- .github/linters/.eslintrc.yml | 76 +++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 .github/linters/.eslintrc.yml diff --git a/.github/linters/.eslintrc.yml b/.github/linters/.eslintrc.yml new file mode 100644 index 0000000..7fcfc03 --- /dev/null +++ b/.github/linters/.eslintrc.yml @@ -0,0 +1,76 @@ +--- +############################# +############################# +## JavaScript Linter rules ## +############################# +############################# + +############ +# Env Vars # +############ +env: + browser: true + es6: true + jest: true + +############### +# Global Vars # +############### +globals: + Atomics: readonly + SharedArrayBuffer: readonly + +ignorePatterns: + - "!.*" + - "**/node_modules/.*" + +############### +# Parser vars # +############### +parser: '@typescript-eslint/parser' +parserOptions: + ecmaVersion: 2018 + sourceType: module + +########### +# Plugins # +########### +plugins: + - '@typescript-eslint' + +######### +# Rules # +######### +rules: { } + +############################## +# Overrides for JSON parsing # +############################## +overrides: + + # JSON files + - files: + - "*.json" + extends: + - plugin:jsonc/recommended-with-json + parser: jsonc-eslint-parser + parserOptions: + jsonSyntax: JSON + + # JSONC files + - files: + - "*.jsonc" + extends: + - plugin:jsonc/recommended-with-jsonc + parser: jsonc-eslint-parser + parserOptions: + jsonSyntax: JSONC + + # JSON5 files + - files: + - "*.json5" + extends: + - plugin:jsonc/recommended-with-json5 + parser: jsonc-eslint-parser + parserOptions: + jsonSyntax: JSON5 \ No newline at end of file From 8278676eb1dfbb5e9341f02fa99f7fbccfe2431f Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Sun, 15 Oct 2023 07:35:55 +0200 Subject: [PATCH 16/24] Ignore devcontainer.json Workaround for https://github.com/B-AROL-O/ARNEIS/actions/runs/6517563199 --- .github/linters/.eslintrc.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/linters/.eslintrc.yml b/.github/linters/.eslintrc.yml index 7fcfc03..1795c0f 100644 --- a/.github/linters/.eslintrc.yml +++ b/.github/linters/.eslintrc.yml @@ -21,6 +21,7 @@ globals: SharedArrayBuffer: readonly ignorePatterns: + - ".devcontainer/devcontainer.json" - "!.*" - "**/node_modules/.*" From 239cde93647321f63933aa4bda9b6ed3ac2b53e6 Mon Sep 17 00:00:00 2001 From: Pietro d'Agostino <90387263+pitdagosti@users.noreply.github.com> Date: Fri, 27 Oct 2023 10:40:08 +0200 Subject: [PATCH 17/24] Create howto-install-eclipse-capella.md --- docs/howto/howto-install-eclipse-capella.md | 130 ++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 docs/howto/howto-install-eclipse-capella.md diff --git a/docs/howto/howto-install-eclipse-capella.md b/docs/howto/howto-install-eclipse-capella.md new file mode 100644 index 0000000..4aade69 --- /dev/null +++ b/docs/howto/howto-install-eclipse-capella.md @@ -0,0 +1,130 @@ +# HOWTO Install Eclipse Capella + +## Executive Summary + +This document explains how to install [Eclipse Capella™](https://www.eclipse.org/capella/) - an Open Source solution for Model-Based Systems Engineering. + +## Introduction to Eclipse Capella™ + +Eclipse Capella™ is a comprehensive, extensible and field-proven MBSE tool and method to successfully design systems architecture. + + + +### References + +* + +## Install Capella (on MS Windows) + +1. From your browser open + +2. Click "GET CAPELLA 6.1 FOR WINDOWS 64-BIT". + + ![image](https://github.com/B-AROL-O/ARNEIS/assets/75182/871df363-b8a1-4247-be3e-1ad9a1774ad6) + + You may select another mirror if you like, otherwise click "Download". + + ![image](https://github.com/B-AROL-O/ARNEIS/assets/75182/7f1ecce0-cb6e-4aa7-9387-0bcb2abe23de) + + You may also support the Eclipse Community by donating some money. + + * Result: file `capella-6.1.0.202303291413-win32-win32-x86_64.zip` will be downloaded + +3. Extract the file from the ZIP archive. + + ```text + mkdir /c/opt/capella + cd /c/opt/capella + unzip $HOME/Downloads/capella-*.zip + ls -la + ``` + + Result: + + ```text + gianpaolo.macario@HW2457 MINGW64 /c/opt/capella + $ ls -la * + capella: + total 2226 + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:20 ./ + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:21 ../ + -rw-r--r-- 1 gianpaolo.macario 1049089 61 Jun 11 2021 .eclipseproduct + -rw-r--r-- 1 gianpaolo.macario 1049089 446509 Mar 29 2023 artifacts.xml + -rwxr-xr-x 1 gianpaolo.macario 1049089 426152 Mar 29 2023 capella.exe* + -rw-r--r-- 1 gianpaolo.macario 1049089 304 Mar 29 2023 capella.ini + -rwxr-xr-x 1 gianpaolo.macario 1049089 131240 Mar 29 2023 capellac.exe* + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:20 configuration/ + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:20 dropins/ + -rw-r--r-- 1 gianpaolo.macario 1049089 16536 Jun 29 2022 epl-v10.html + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:20 features/ + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:20 jre/ + -rw-r--r-- 1 gianpaolo.macario 1049089 9230 Jun 29 2022 notice.html + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:20 p2/ + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:21 plugins/ + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:21 readme/ + + samples: + total 3008 + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:21 ./ + drwxr-xr-x 1 gianpaolo.macario 1049089 0 Oct 9 13:21 ../ + -rw-r--r-- 1 gianpaolo.macario 1049089 3077889 Mar 29 2023 IFE_samplemodel.zip + + gianpaolo.macario@HW2457 MINGW64 /c/opt/capella + $ + ``` + +You can now launch Capella with the following command-line: + +```bash +/c/opt/capella/capella/capella.exe +``` + +The Capella splash screen should be displayed + +![image](https://user-images.githubusercontent.com/75182/273572772-44584c1b-85d4-4a53-b37e-0cb23b658817.png) + +Once you confirm the workspace directory, after a few seconds Capella main windows should eventually be displayed: + +![image](https://user-images.githubusercontent.com/75182/273573441-c80760c1-f403-4150-b2f6-f042c5cd7971.png) + +## Install Capella (on Ubuntu 64-bit) + +1. Go to [Capella - Downloads](https://www.eclipse.org/capella/download.html) + + * Look at section "Other Platforms" > "Linux". + * If you have an Intel CPU, choose "64-bit"; for ARM 64-bit, choose "aarch64". + * Result: file `capella-6.1.0.202303291413-linux-gtk-x86_64.tar.gz` will be downloaded + +2. Extract the file from the tar archive: + + ```bash + sudo mkdir -p /opt/capella + sudo tar -C /opt/capella -xvzf capella-*.tar.gz + ``` + +3. You can launch Capella with the following command-line + + ```bash + /opt/capella/capella/capella + ``` + +## Install Capella (on macOS) + +1. Go to [Capella - Downloads](https://www.eclipse.org/capella/download.html) and choose the file right for your operating system: + * If you have an Intel Mac, choose "64-bit"; otherwise, choose "aarch64". + +2. Extract the file from the tar archive. + +3. Drag the application into the Applications folder. + +4. Launch terminal. + +5. Copy and paste the following command: + + ```console + xattr -d com.apple.quarantine /Applications/Capella.app + ``` + +Then, the program is ready to be used. + + From 4d1d50f6df653249e8e181f2a089baa525728552 Mon Sep 17 00:00:00 2001 From: Pietro d'Agostino <90387263+pitdagosti@users.noreply.github.com> Date: Fri, 27 Oct 2023 10:51:02 +0200 Subject: [PATCH 18/24] fixed linter errors --- docs/howto/howto-install-eclipse-capella.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/howto/howto-install-eclipse-capella.md b/docs/howto/howto-install-eclipse-capella.md index 3ea12b6..8f150a4 100644 --- a/docs/howto/howto-install-eclipse-capella.md +++ b/docs/howto/howto-install-eclipse-capella.md @@ -6,7 +6,7 @@ This document explains how to install [Eclipse Capella™](https://www.eclip ## Introduction to Eclipse Capella™ -Eclipse Capella™ is a comprehensive, extensible and field-proven MBSE tool and method to successfully design systems architecture. +Eclipse Capella™ is a comprehensive, extensible, and field-proven MBSE tool and method to design systems architecture successfully. @@ -22,7 +22,7 @@ Eclipse Capella™ is a comprehensive, extensible and field-proven MBSE tool and ![image](https://github.com/B-AROL-O/ARNEIS/assets/75182/871df363-b8a1-4247-be3e-1ad9a1774ad6) - You may select another mirror if you like, otherwise click "Download". + You may select another mirror if you like. Otherwise, click "Download". ![image](https://github.com/B-AROL-O/ARNEIS/assets/75182/7f1ecce0-cb6e-4aa7-9387-0bcb2abe23de) @@ -73,13 +73,13 @@ Eclipse Capella™ is a comprehensive, extensible and field-proven MBSE tool and $ ``` -You can now launch Capella with the following command-line: +You can now launch Capella with the following command line: ```bash /c/opt/capella/capella/capella.exe ``` -The Capella splash screen should be displayed +The Capella splash screen should be displayed. ![image](https://user-images.githubusercontent.com/75182/273572772-44584c1b-85d4-4a53-b37e-0cb23b658817.png) @@ -91,7 +91,7 @@ Once you confirm the workspace directory, after a few seconds Capella main windo 1. Go to [Capella - Downloads](https://www.eclipse.org/capella/download.html) - * Look at section "Other Platforms" > "Linux". + * Look at the section "Other Platforms" > "Linux". * If you have an Intel CPU, choose "64-bit"; for ARM 64-bit, choose "aarch64". * Result: file `capella-6.1.0.202303291413-linux-gtk-x86_64.tar.gz` will be downloaded @@ -102,7 +102,7 @@ Once you confirm the workspace directory, after a few seconds Capella main windo sudo tar -C /opt/capella -xvzf capella-*.tar.gz ``` -3. You can launch Capella with the following command-line +3. You can launch Capella with the following command line ```bash /opt/capella/capella/capella @@ -126,7 +126,7 @@ Once you confirm the workspace directory, after a few seconds Capella main windo ``` Then, the program is ready to be used. -======= + ## Step-by-step instructions Open and download the version of Capella suitable for your host HW and OS. @@ -134,7 +134,7 @@ In my case (HW2457) this is "CAPELLA 6.1 FOR WINDOWS 64-BIT". ![image](https://github.com/B-AROL-O/ARNEIS/assets/75182/871df363-b8a1-4247-be3e-1ad9a1774ad6) -You may select another mirror if you like, otherwise click "Download". +You may select another mirror if you like. Otherwise, click "Download". ![image](https://github.com/B-AROL-O/ARNEIS/assets/75182/7f1ecce0-cb6e-4aa7-9387-0bcb2abe23de) From 7aedc8400dc78730681ef9cef78e09c9e840af0a Mon Sep 17 00:00:00 2001 From: Pietro d'Agostino <90387263+pitdagosti@users.noreply.github.com> Date: Fri, 27 Oct 2023 10:54:53 +0200 Subject: [PATCH 19/24] fixed linter errors --- docs/howto/howto-install-eclipse-capella.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/howto/howto-install-eclipse-capella.md b/docs/howto/howto-install-eclipse-capella.md index 8f150a4..2342b9f 100644 --- a/docs/howto/howto-install-eclipse-capella.md +++ b/docs/howto/howto-install-eclipse-capella.md @@ -73,7 +73,7 @@ Eclipse Capella™ is a comprehensive, extensible, and field-proven MBSE tool an $ ``` -You can now launch Capella with the following command line: +You can now launch Capella with the following command-line: ```bash /c/opt/capella/capella/capella.exe @@ -102,7 +102,7 @@ Once you confirm the workspace directory, after a few seconds Capella main windo sudo tar -C /opt/capella -xvzf capella-*.tar.gz ``` -3. You can launch Capella with the following command line +3. You can launch Capella with the following command-line ```bash /opt/capella/capella/capella From 84a4e060bb39cab905e7ba0458f38672d6619271 Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Fri, 27 Oct 2023 12:58:22 +0200 Subject: [PATCH 20/24] howto-install-eclipse-capella.md: Remove extra TODO --- docs/howto/howto-install-eclipse-capella.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/howto/howto-install-eclipse-capella.md b/docs/howto/howto-install-eclipse-capella.md index 2342b9f..89dd4a7 100644 --- a/docs/howto/howto-install-eclipse-capella.md +++ b/docs/howto/howto-install-eclipse-capella.md @@ -140,6 +140,4 @@ You may select another mirror if you like. Otherwise, click "Download". You may also support the Eclipse Community by donating some money. -TODO - From 6b7977c3896b6171a8a1e976beabb3079fac5954 Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Fri, 27 Oct 2023 13:01:26 +0200 Subject: [PATCH 21/24] howto-install-eclipse-capella.md: Embed YouTube video: Discover Capella in 2 minutes --- docs/howto/howto-install-eclipse-capella.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto/howto-install-eclipse-capella.md b/docs/howto/howto-install-eclipse-capella.md index 89dd4a7..72c5947 100644 --- a/docs/howto/howto-install-eclipse-capella.md +++ b/docs/howto/howto-install-eclipse-capella.md @@ -8,7 +8,7 @@ This document explains how to install [Eclipse Capella™](https://www.eclip Eclipse Capella™ is a comprehensive, extensible, and field-proven MBSE tool and method to design systems architecture successfully. - +[![Discover Capella in 2 minutes](https://img.youtube.com/vi/WSzlN4YT3gM/0.jpg)](https://www.youtube.com/watch?v=WSzlN4YT3gM "Discover Capella in 2 minutes") ### References From 54fe984c5662d42c05669b71032ad5bd64891acc Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Fri, 27 Oct 2023 13:15:24 +0200 Subject: [PATCH 22/24] howto-install-eclipse-capella.md: Delete duplicate section Section "Install Capella (on MS Windows)" was already present earlier in the document. --- docs/howto/howto-install-eclipse-capella.md | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/docs/howto/howto-install-eclipse-capella.md b/docs/howto/howto-install-eclipse-capella.md index 72c5947..553a98e 100644 --- a/docs/howto/howto-install-eclipse-capella.md +++ b/docs/howto/howto-install-eclipse-capella.md @@ -127,17 +127,4 @@ Once you confirm the workspace directory, after a few seconds Capella main windo Then, the program is ready to be used. -## Step-by-step instructions - -Open and download the version of Capella suitable for your host HW and OS. -In my case (HW2457) this is "CAPELLA 6.1 FOR WINDOWS 64-BIT". - -![image](https://github.com/B-AROL-O/ARNEIS/assets/75182/871df363-b8a1-4247-be3e-1ad9a1774ad6) - -You may select another mirror if you like. Otherwise, click "Download". - -![image](https://github.com/B-AROL-O/ARNEIS/assets/75182/7f1ecce0-cb6e-4aa7-9387-0bcb2abe23de) - -You may also support the Eclipse Community by donating some money. - From 46f6200f051f63b599616e5abc8629e5c2782286 Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Tue, 31 Oct 2023 19:55:11 +0100 Subject: [PATCH 23/24] README.md: Trivial typo fix s/Jupyther/Jupyter/ --- code/lego-parts-csv2md/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/lego-parts-csv2md/README.md b/code/lego-parts-csv2md/README.md index ef1bf8e..30e70d5 100644 --- a/code/lego-parts-csv2md/README.md +++ b/code/lego-parts-csv2md/README.md @@ -70,7 +70,7 @@ Select the `Run All` menu entry and wait... > **ATTENTION** > > The first time you try to run app, VSC will ask to install other needed libraries. -> In particular it need to install `ipykernel` to be able to run your _Jupyther Notebook_ app. +> In particular it need to install `ipykernel` to be able to run your _Jupyter Notebook_ app. > > **Accept the automatic installation of all extensions** > From 5db09591b754f998f90234759a8452da1917b71c Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Tue, 31 Oct 2023 19:57:12 +0100 Subject: [PATCH 24/24] README.md: Add missing "the" --- code/lego-parts-csv2md/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/lego-parts-csv2md/README.md b/code/lego-parts-csv2md/README.md index 30e70d5..85befa4 100644 --- a/code/lego-parts-csv2md/README.md +++ b/code/lego-parts-csv2md/README.md @@ -7,7 +7,7 @@ The tool is written as a Python [Jupyter Notebook](https://jupyter.org) and can ## Python environment -Obviously you need to have `python3` installed on your system. In case you haven't it you can follow instructions from [python.org](https://www.python.org) or any tutorial you can find in the internet. +Obviously you need to have `python3` installed on your system. In case you haven't it you can follow the instructions from [python.org](https://www.python.org) or any tutorial you can find in the internet. Since this tool depends on a few libraries we suggest to create a [virtual environment](https://docs.python.org/3/library/venv.html) where to install those libraries keeping your system clean.