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

Provide embedded documentation #35

Closed
angelozerr opened this issue Dec 7, 2020 · 1 comment · Fixed by #80
Closed

Provide embedded documentation #35

angelozerr opened this issue Dec 7, 2020 · 1 comment · Fixed by #80
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@angelozerr
Copy link
Collaborator

angelozerr commented Dec 7, 2020

It should be nice to have some documentation about:

  • the kafka settings
  • the Kafka explorer

Providing an embedded documentation gives the capability to read the documentation with webrowser (by reading pages from the github repository) or inside vscode.

We did that for vscode-xml, the documentation https://github.com/redhat-developer/vscode-xml/blob/master/docs/README.md can be read too inside vscode with the vscode Open XML Documentation command https://github.com/redhat-developer/vscode-xml/blob/master/docs/Commands.md#commands

@angelozerr angelozerr changed the title Provide embed documentation Provide embedded documentation Dec 8, 2020
@fbricon fbricon added the enhancement New feature or request label Dec 19, 2020
@angelozerr
Copy link
Collaborator Author

I will create a PR soon for that.

@angelozerr angelozerr self-assigned this Jan 11, 2021
@angelozerr angelozerr added this to the 0.11.0 milestone Jan 11, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 12, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 12, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 12, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 12, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 19, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 25, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 25, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 25, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 25, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 26, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 27, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 27, 2021
angelozerr added a commit to angelozerr/vscode-kafka that referenced this issue Jan 27, 2021
fbricon pushed a commit that referenced this issue Jan 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants