Skip to content

Update BUILDING.md #1281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 3, 2022
Merged

Update BUILDING.md #1281

merged 2 commits into from
Aug 3, 2022

Conversation

InstantMuffin
Copy link
Contributor

@InstantMuffin InstantMuffin commented Aug 3, 2022

Added "Notes for Linux contributors" based on my own building experience

Motivation

I wanted to test out #1279 for myself without having to wait for the nightly build.

Change description

The changes in BUILDING.md add a subcategory for Linux contributors which talks about issues that arise by missing dependencies.

Other information

I had these minor setbacks doing the build myself and saw that there was no subcategory in this manual for Linux users. I think it is handy to streamline the build process and therefore its documentation as much as possible to encourage maybe even very novice contributors that can then easily add minor and simple fixes and test them out on their own. Or possibly do it for the reasons I did it, to test changes without having to wait for the nightly build.

Reviewer checklist

  • PR addresses a single concern.
  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • PR title and description are properly filled.
  • Docs have been added / updated (for bug fixes / features)

Added "Notes for Linux contributors" based on my own building experience
@CLAassistant
Copy link

CLAassistant commented Aug 3, 2022

CLA assistant check
All committers have signed the CLA.

@kittaakos
Copy link
Contributor

I wanted to test out #1279 for myself without having to wait for the nightly build.

Thank you! ❤️ . If you have a GH account, you can log in and download the artifacts from GH. No need to wait until the next nightly runs. If you need assistance with the exact steps, let me know.

In the docs, we have this section:

Build from source

If you’re familiar with TypeScript, the Theia IDE, and if you want to contribute to the project, you should be able to build the Arduino IDE locally. Please refer to the Theia IDE prerequisites documentation for the setup instructions.

As I see the Theia IDE prerequisites link points to an incorrect location, but Theia already defines what is required per platform.

See here: https://github.com/eclipse-theia/theia/blob/master/doc/Developing.md#prerequisites

Since the Arduino IDE2 does not require more than Theia, I would like to avoid re-defining and maintaining the requirements.

However, I am more than happy to accept this PR if you can verify the Theia requirements are sufficient and that our docs point to the correct location in the Theia repo. What do you think, @InstantMuffin?

@kittaakos kittaakos self-requested a review August 3, 2022 13:10
@InstantMuffin
Copy link
Contributor Author

The Theia requirements are sufficient. They completely include the packages I refer to.
I think this can be closed without any changes made to be honest. With a bit of rtfm on my side I could have seen this and clicked on that link.

In terms of downloading the artifacts, I found them. Turns out scrolling down really hard helps.

Thank you for your help and your contributions in general.

@kittaakos
Copy link
Contributor

I think this can be closed without any changes made to be honest.

Your remark and the proposed changes are very important to us; it shows that the doc can be improved to help external contributors. Would you be interested in adjusting your PR to include the correct link in the doc?

diff --git a/BUILDING.md b/BUILDING.md
index ed13b2e9..8f26cc97 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -41,7 +41,7 @@ The _frontend_ is running as an Electron renderer process and can invoke service
 
 If you’re familiar with TypeScript, the [Theia IDE](https://theia-ide.org/), and if you want to contribute to the
 project, you should be able to build the Arduino IDE locally.
-Please refer to the [Theia IDE prerequisites](https://github.com/theia-ide/theia/blob/master/doc/) documentation for the setup instructions.
+Please refer to the [Theia IDE prerequisites](https://github.com/eclipse-theia/theia/blob/master/doc/Developing.md#prerequisites) documentation for the setup instructions.
 > **Note**: Node.js 14 must be used instead of the version 12 recommended at the link above.
 
 Once you have all the tools installed, you can build the editor following these steps

@InstantMuffin
Copy link
Contributor Author

Sure, and I understood your request in me doing so, but I think it's quite a microoptimization between pointing to the right file and showing the otherwise very useful documentation in case something goes wrong during the build process.

Honestly I think the doc is currently as good as can be.
I would at most propose to change the link and nothing else.

Removing the linux specific section and instead updating the Theia IDE prerequisites link to point to the mentioned file directly.
Copy link
Contributor

@kittaakos kittaakos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for your contribution.

@kittaakos kittaakos merged commit 879aede into arduino:main Aug 3, 2022
@per1234 per1234 added topic: documentation Related to documentation for the project topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project topic: theia Related to the Theia IDE framework labels Aug 3, 2022
@per1234 per1234 mentioned this pull request Apr 22, 2023
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project topic: infrastructure Related to project infrastructure topic: theia Related to the Theia IDE framework type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants