Skip to content
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

Added Theia project goals #280

Merged
merged 14 commits into from
Apr 26, 2022
Merged

Added Theia project goals #280

merged 14 commits into from
Apr 26, 2022

Conversation

JonasHelming
Copy link
Contributor

fixed #279

Signed-off-by: Jonas Helming jhelming@eclipsesource.com

Signed-off-by: Jonas Helming <jhelming@eclipsesource.com>
Copy link

@colin-grant-work colin-grant-work left a comment

Choose a reason for hiding this comment

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

Just a quick read through and some stylistic and copy-editorial feedback.

src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
JonasHelming and others added 9 commits March 15, 2022 22:16
Co-authored-by: colin-grant-work <colin.grant@est.tech>
Co-authored-by: colin-grant-work <colin.grant@est.tech>
Co-authored-by: colin-grant-work <colin.grant@est.tech>
Co-authored-by: colin-grant-work <colin.grant@est.tech>
Co-authored-by: colin-grant-work <colin.grant@est.tech>
Co-authored-by: colin-grant-work <colin.grant@est.tech>
Co-authored-by: colin-grant-work <colin.grant@est.tech>
Co-authored-by: colin-grant-work <colin.grant@est.tech>
Co-authored-by: colin-grant-work <colin.grant@est.tech>
@JonasHelming
Copy link
Contributor Author

@colin-grant-work Thank you for this great review!

Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

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

My comments are mainly for formatting and aesthetics, I did not dive deep into the actual content like Colin's previous feedback.

src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved

Theia provides a workbench frame, i.e., a window management system permitting the display of views, editors, and menus and makes available tools and interactions allowing the user to modify of the window layout, trigger commands, and use key bindings and other concepts known from a desktop tool such as drag and drop.

## Reusable Common Tool Features
Copy link
Member

Choose a reason for hiding this comment

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

minor: we might want a better title for this section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you have a suggestion?

Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure, perhaps Reusable and Extensible Components? If I understand correctly you're trying to describe how extensions which contribute functionality to the framework can be re-used across different products and can be extended to suit an application's potentially unique requirements. I did not understand the use of "tool features" in this context.

Choose a reason for hiding this comment

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

What if we moved this paragraph into the next section? Reusability is what facilitates 'Extensibility and Adaptability': we provide components that are generic enough to be of interest to a variety of tools, and they're flexible enough to be reused with customizations.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, I am not sure about this. I personally find the fact that the platform provides features that you can resue important enough for a dedicated point. It is one of the core motivations to use a platform. Need a file explorer in your tool? Get it by just reusing it! So I would not mix "extensibility and adaptability" (section below) into this section.

src/docs/project_goals.md Show resolved Hide resolved
src/docs/project_goals.md Outdated Show resolved Hide resolved
JonasHelming and others added 3 commits March 16, 2022 17:03
Co-authored-by: Vincent Fugnitto <vincent.fugnitto@ericsson.com>
Co-authored-by: Vincent Fugnitto <vincent.fugnitto@ericsson.com>
Signed-off-by: Jonas Helming <jhelming@eclipsesource.com>
Signed-off-by: Jonas Helming <jhelming@eclipsesource.com>
Copy link

@colin-grant-work colin-grant-work left a comment

Choose a reason for hiding this comment

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

Looks good to me! Certainly a good start, and we can continue to iterate on it as our goals evolve.


## Use Standards And Don’t Reinvent The Wheel

Theia uses/reuses industrial standard technologies and practices whenever applicable. This keeps the scope of the project minimal and decreases the maintenance cost. This applies to the use of frameworks and development tools as well as to general concepts such as UX.
Copy link
Member

Choose a reason for hiding this comment

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

Could use the debug adapter protocol and LSP as examples here?


## VS Code Compatibility

Theia provides the ability to host VS Code extensions. This allows adopters to benefit from features that are provided as VS Code extensions and make them part of their tool offering. It also allows end users of Theia-based tools to install additional features, if the adopter providing a tool allows users to do so. When applicable, the default Theia UX aligns with the VS Code UI, although adopters can deviate from this.
Copy link
Member

Choose a reason for hiding this comment

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

Is open-vsx worth mentioning?

@thegecko
Copy link
Member

+1

@JonasHelming JonasHelming merged commit 1653526 into master Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add project goals to overview documentation
5 participants