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.

Sign up for GitHub

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

Jump to bottom

[getting-started] update extension readme following updated template #7077

Merged
merged 1 commit into from
Feb 27, 2020
Merged

[getting-started] update extension readme following updated template #7077

merged 1 commit into from
Feb 27, 2020

Conversation

vince-fugnitto
Copy link
Member

@vince-fugnitto vince-fugnitto commented Feb 4, 2020 •
edited
Loading

What it does

Updates the getting-started extension readme following the new template.
The new template consists of:

  • extension header
  • extension description
  • extension docs: generated API documentation
  • extension license
  • extension trademark

How to test

Review rendered readme content.

Review checklist

Reminder for reviewers

@vince-fugnitto vince-fugnitto added documentation issues related to documentation getting-started issues related to the getting-started extension labels Feb 4, 2020
@vince-fugnitto vince-fugnitto self-assigned this Feb 4, 2020
@vince-fugnitto
Copy link
Member Author

This is a tentative template regarding improvements for #6518. The goal is to provide a readme which contains the necessary information to understand an extension at a high-level and not require constant updates.

The template includes:

  • an update header (mainly for aesthetic purposes as the readme is displayed on npm)
  • a high-level description of the extension
  • a link to the generated documentation for the readme
  • license section
  • trademark section

I welcome any feedback 😃

@marcdumais-work
Copy link
Contributor

Very good start - I like the (limited) level of details - there should be little need to update unless there are major changes in the extension. The presentation is nice as well.

@eclipse-theia/core : Please have a look and comment. Once we start updating the various extension's README.md in the same way, it will be too late to suggest changes to the template :)

lmcbout
lmcbout reviewed Feb 5, 2020
View reviewed changes
Copy link
Contributor

@lmcbout lmcbout left a comment

Choose a reason for hiding this comment

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

Looks nice,
important info is available
Question: Should we have a link to the Theia source code somewhere
https://github.com/eclipse-theia/theia
https://theia-ide.org/
https://theia-ide.org/docs/

logo/theia.svg Show resolved Hide resolved
@vince-fugnitto vince-fugnitto force-pushed the vf/getting-started-readme branch from d66365f to 985b94e Compare February 5, 2020 15:31
@vince-fugnitto
[getting-started] update extension readme
21918a5 
Updates the `getting-started` extension readme following the new template.
The new template consists of:
- extension header
- extension description
- extension docs: generated API documentation
- extension license
- extension trademark

Signed-off-by: Vincent Fugnitto <vincent.fugnitto@ericsson.com>
@vince-fugnitto vince-fugnitto force-pushed the vf/getting-started-readme branch from 985b94e to 21918a5 Compare February 5, 2020 15:58
marcdumais-work
marcdumais-work approved these changes Feb 11, 2020
View reviewed changes
Copy link
Contributor

@marcdumais-work marcdumais-work left a comment

Choose a reason for hiding this comment

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

LGTM, which is not surprising since we talked while you were working-up to this PR. Let's give it a couple more days before merging, in case others have comments - I added a dev-meeting item pointing here.

@vince-fugnitto vince-fugnitto marked this pull request as ready for review February 12, 2020 18:02
@vince-fugnitto
Copy link
Member Author

vince-fugnitto commented Feb 12, 2020 •
edited
Loading

I haven't gotten much feedback regarding the new extension template so I'll assume that the content is fine, I'll proceed with updating the existing extension's readme (excluding soon to be deprecated extension as described in #6933).

@vince-fugnitto vince-fugnitto added this to the Theia 1.0.0 milestone Feb 12, 2020
@marcdumais-work marcdumais-work merged commit 03c0ad2 into master Feb 27, 2020
@marcdumais-work marcdumais-work deleted the vf/getting-started-readme branch February 27, 2020 02:08
@marcdumais-work marcdumais-work mentioned this pull request Feb 27, 2020
Closed
@vince-fugnitto vince-fugnitto mentioned this pull request Mar 2, 2020
Merged
43 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lmcbout lmcbout lmcbout left review comments

@marcdumais-work marcdumais-work marcdumais-work approved these changes

@akosyakov akosyakov Awaiting requested review from akosyakov

@benoitf benoitf Awaiting requested review from benoitf

@kittaakos kittaakos Awaiting requested review from kittaakos

@paul-marechal paul-marechal Awaiting requested review from paul-marechal

@svenefftinge svenefftinge Awaiting requested review from svenefftinge

Assignees

@vince-fugnitto vince-fugnitto

Labels
documentation issues related to documentation getting-started issues related to the getting-started extension
Projects
None yet
Milestone
Theia 1.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@vince-fugnitto @marcdumais-work @lmcbout