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

readme: update individual ext readmes #7254

Merged
merged 1 commit into from
Mar 12, 2020
Merged

Conversation

vince-fugnitto
Copy link
Member

What it does

Fixes #6518

The following pull-request updates the readme for each individual extension following the updates made to the getting-started extension (#7077).

This includes:

  • a uniform header (with theia icon, and extension name)
  • a low maintenance description of the given extension
  • helpful links including the generate API docs when possible
Updates

dev-packages

  • application-manager
  • application-package
  • cli
  • electron

packages

  • callhierarchy
  • console
  • core
  • debug
  • editor
  • editor-preview
  • file-search
  • filesystem
  • getting-started
  • git
  • json
  • keymaps
  • languages
  • markers
  • messages
  • metrics
  • mini-browser
  • monaco
  • navigator
  • outline-view
  • output
  • plugin
  • plugin-dev
  • plugin-ext
  • plugin-ext-vscode
  • plugin-metrics
  • preferences
  • preview
  • process
  • scm
  • scm-extra
  • search-in-workspace
  • task
  • terminal
  • typehierarchy
  • userstorage
  • variable-resolver
  • workspace

How to test

Verify the content of the readmes.

Review checklist

Reminder for reviewers

Signed-off-by: vince-fugnitto [email protected]

@vince-fugnitto vince-fugnitto added the documentation issues related to documentation label Mar 2, 2020
@vince-fugnitto vince-fugnitto self-assigned this Mar 2, 2020
packages/core/README.md Outdated Show resolved Hide resolved
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.

Just look at the text, one seems missing the Description.
Looks ok, consistent between each README.md files

packages/plugin/README.md Show resolved Hide resolved
@vince-fugnitto vince-fugnitto force-pushed the vf/GH-6518-readme branch 3 times, most recently from 388fdc6 to a3c2a3a Compare March 2, 2020 20:46
Fixes #6518

The following commit updates the readme's of each individual ext
present in the main repository to follow the new template proposed from
the `getting-started` update.

The readmes are updated to use a uniform template, a brief description
of their functionality, useful links (ex: generated API docs), and
the Eclipse license and Theia trademark.

Signed-off-by: vince-fugnitto <[email protected]>
@vince-fugnitto vince-fugnitto marked this pull request as ready for review March 9, 2020 15:08
Copy link
Member

@paul-marechal paul-marechal left a comment

Choose a reason for hiding this comment

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

LGTM

@akosyakov
Copy link
Member

We can improve later. Let's merge?

@vince-fugnitto
Copy link
Member Author

We can improve later. Let's merge?

Sounds good, I'll merge and we can improve iteratively.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[documentation] improve the documentation of extension 'readme'
4 participants