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

[FEATURE]: add information about updating jayvee extension in the docs #480

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions apps/docs/docs/user/intro/_category_.json
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."
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 1
title: Getting Started
---

# Introduction to Jayvee
Expand All @@ -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

Expand Down Expand Up @@ -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 with inline explanations [here](../examples/README.mdx). You can copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)).

## VSCode Plugin

Expand Down
3 changes: 3 additions & 0 deletions apps/docs/docs/user/intro/intro.md.license
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
52 changes: 52 additions & 0 deletions apps/docs/docs/user/intro/update.md
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.
3 changes: 3 additions & 0 deletions apps/docs/docs/user/intro/update.md.license
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
Loading