-
Notifications
You must be signed in to change notification settings - Fork 15
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
[FEATURE]: add information about updating jayvee extension in the docs #480
Merged
rhazn
merged 17 commits into
jvalue:main
from
OmarFourati:feature/update-docs-for-jayvee-updating
Feb 1, 2024
Merged
Changes from 14 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
941926c
add information about updating jayvee extension
OmarFourati ee4103f
refactor: small enhancement on added documentation
OmarFourati 3108169
refactor: update documentation for updating jayvee
OmarFourati 7b719b4
refactor: add link to the new update page
OmarFourati e7e9934
fix: fix typo
OmarFourati ba669e1
vscode extension manual update documentation
OmarFourati e2d02e2
update new page postion and create license info
OmarFourati d341ba5
resolve conflicts
OmarFourati 88af75c
update docus with introduction to jayvee and update page
OmarFourati ca06b6f
place intro and update page under introduction to jayvee
OmarFourati 408c707
last typo update
OmarFourati 027c0b8
fix: review changes
OmarFourati ff21208
Merge main into feature/update-docs-for-jayvee-updating
OmarFourati 82000d2
fix: create license files
OmarFourati f27bbb3
fix: revert change with linking example and not github
OmarFourati aa66198
fix: fix examples link
OmarFourati cf9b084
Merge branch 'main' into feature/update-docs-for-jayvee-updating
rhazn File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "Introduction to Jayvee", | ||
"position": 1, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "All the essential information to get started with Jayvee." | ||
} | ||
} |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
--- | ||
sidebar_position: 1 | ||
title: Getting Started | ||
--- | ||
|
||
# Introduction to Jayvee | ||
|
@@ -24,11 +25,7 @@ npm install -g @jvalue/[email protected] | |
|
||
## Update | ||
|
||
Updating the interpreter is done by reinstalling it using `npm`. Make sure to also update the [VSCode plugin](#vscode-plugin) to match the installed interpreter if you use it. | ||
|
||
```bash | ||
npm install -g @jvalue/jayvee-interpreter | ||
``` | ||
Details about how to update Jayvee and the VSCode extension can be found [here](./update.md). | ||
|
||
## Usage | ||
|
||
|
@@ -83,7 +80,7 @@ jv <file> -d --debug-granularity peek --debug-target MyExtractorBlock,MySinkBloc | |
|
||
## Examples | ||
|
||
You can find multiple examples with inline explanations [here](./examples/README.mdx). | ||
You can find multiple examples [here](https://github.com/jvalue/jayvee/tree/main/example). Copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)). | ||
|
||
## VSCode Plugin | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg | ||
|
||
SPDX-License-Identifier: AGPL-3.0-only |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
sidebar_position: 2 | ||
title: Update Jayvee | ||
--- | ||
|
||
# How to update Jayvee | ||
|
||
Jayvee is consistently getting updates. To ensure you use the most recent version, please regularly update the interpreter and VSCode extension. | ||
|
||
### Update Jayvee + Extension | ||
|
||
To update Jayvee, you need to: | ||
|
||
1. Update the interpreter by reinstalling it using npm: | ||
|
||
```bash | ||
npm install -g @jvalue/jayvee-interpreter | ||
``` | ||
|
||
Note: Updating to a specific version works using the `@`-syntax, e.g., version `0.0.17`: | ||
|
||
```bash | ||
npm install -g @jvalue/[email protected] | ||
``` | ||
|
||
2. Update your VSCode Extension: | ||
|
||
- Go [here](https://github.com/jvalue/jayvee/releases/latest) to find the latest(or a specific) version of the VSCode Extenstion. | ||
|
||
- Then, download the latest `jayvee.vsix` file. | ||
|
||
- Finally, to install the extension using the CLI, paste the code below into your command line: | ||
|
||
```bash | ||
code --install-extension jayvee.vsix | ||
``` | ||
|
||
If you'd rather use the manual installation, follow this [link](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) for the official VSCode documentation. | ||
|
||
### Version Check | ||
|
||
To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your command line: | ||
|
||
For **Jayvee**: | ||
|
||
```bash | ||
jv -V | ||
``` | ||
|
||
For the **VSCode extension**: | ||
|
||
Go to the extensions menu, and look for `Jayvee`. The version is then displayed on the information page of the extension. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg | ||
|
||
SPDX-License-Identifier: AGPL-3.0-only |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should be reverted/combined again, we decided to link to the examples in the docs, not on github.