[FEATURE]: add information about updating jayvee extension in the docs #480
Conversation
apps/docs/docs/user/intro.md
Outdated
| @@ -23,6 +24,10 @@ npm install -g @jvalue/[email protected] | |||
|
|
|||
| 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. | |||
|
|
|||
| IMPORTANT: If a new Jayvee update is available, you need to update your Jayvee extension as well. | |||
There was a problem hiding this comment.
"Your VSCode extension for Jayvee" would be the correct wording.
apps/docs/docs/user/intro.md
Outdated
| @@ -23,6 +24,10 @@ npm install -g @jvalue/[email protected] | |||
|
|
|||
| 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. | |||
|
|
|||
| IMPORTANT: If a new Jayvee update is available, you need to update your Jayvee extension as well. | |||
|
|
|||
| Extensions and updates can be found [here](https://github.com/jvalue/jayvee/releases/tag/v0.2.0-alpha). | |||
There was a problem hiding this comment.
Should link to https://github.com/jvalue/jayvee/releases/latest, not to a specific version.
apps/docs/docs/user/intro.md
Outdated
There was a problem hiding this comment.
Overall it would be good to add a completely new document (e.g., update.md) that we can link to. That document should include only a documentation on how to update to a new Jayvee version:
- That you need to update Jayvee and the VSCode extension both
- The explicit npm install command for that version
- How to update the VSCode extension
- How to verify that you have the right jayvee version installed
- How to verify that you have the right VSCode extension installed
You can then link that new document from here.
There was a problem hiding this comment.
I created the update.md file and logic.
How can I now link this page without having it in the header or on the menu at the left side ? Couldn't find any example of such a situation.
There was a problem hiding this comment.
Not sure actually. We use https://docusaurus.io/ so maybe they have something in their docs? I assume it has something to do with the markdown frontmatter / metadata between the dashes, e.g. for intro.md
---
sidebar_position: 1
---
I assume there is some boolean there that hides it from the menu?
Once you have updated the PR so the comments are fixed, you can retrigger the review by the way, then I can have another look :).
There was a problem hiding this comment.
I was not able to find a solution to not have it in the sidebar.
Solutions ? Leave it right under introduction to Jayvee ?
Another option would be a menu point under : Introduction of Jayvee.
There was a problem hiding this comment.
I Updated the docs in a way that i think is the best within implementing the update page:
Getting started (which is actually the wording I found on 80% of documentations) = the intro page
Update Javee: Information about updating Javee
There was a problem hiding this comment.
@rhazn need review on this to resolve the conversation and ask for an overall review of the PR.
There was a problem hiding this comment.
If you need a review, please re-request a review (top right). But make sure the CI works beforehand, right now it is failing.
OmarFourati
force-pushed
the
feature/update-docs-for-jayvee-updating
branch
from
4649d90 to
d341ba5
Compare
There was a problem hiding this comment.
I think this is well done (after accepting my suggestions/some proofreading ;)). I like the Getting Started wording and I am okay with the category in the docs.
Because it is a larger navigation change I'd run it by @georg-schwarz as well though, would you mind having a look the the screenshot Omar posted? Is that setup okay for you?
| "position": 1, | ||
| "link": { | ||
| "type": "generated-index", | ||
| "description": "All the essentials Information to get started with Javee." |
There was a problem hiding this comment.
Please proofread these texts a bit ;).
| "description": "All the essentials Information to get started with Javee." | |
| "description": "All the essential information to get started with Jayvee." |
apps/docs/docs/user/intro/update.md
Outdated
|
|
||
| # How to update Jayvee | ||
|
|
||
| Jayvee is constently getting updates as a dedicated team of developers diligently addresses performance issues and incorporates new features to meet the evolving needs of its user base. |
There was a problem hiding this comment.
Same here, some proofreading or automated help (I suggest languagetool). Also no need for marketing texts here ;).
| Jayvee is constently getting updates as a dedicated team of developers diligently addresses performance issues and incorporates new features to meet the evolving needs of its user base. | |
| Jayvee is consistently getting updates. To ensure you use the most recent version, please regularly update the interpreter and VSCode extension. |
apps/docs/docs/user/intro/update.md
Outdated
|
|
||
| - Then, download the latest `jayvee.vsix` file. | ||
|
|
||
| - Finally, open your Command Prompt(terminal), and paste the code below: |
There was a problem hiding this comment.
| - Finally, open your Command Prompt(terminal), and paste the code below: | |
| - Finally, to install the extension using the CLI, paste the code below into your command line: |
apps/docs/docs/user/intro/update.md
Outdated
| code --install-extension jayvee.vsix | ||
| ``` | ||
|
|
||
| For manual installation, follow this [link](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) for the official VSCode documentation. |
There was a problem hiding this comment.
| For manual installation, follow this [link](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) for the official VSCode documentation. | |
| 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. |
apps/docs/docs/user/intro/update.md
Outdated
|
|
||
| ### Version Check | ||
|
|
||
| To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your Command Prompt(terminal): |
There was a problem hiding this comment.
| To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your Command Prompt(terminal): | |
| To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your command line: |
apps/docs/docs/user/intro/update.md
Outdated
|
|
||
| For the **VSCode extension**: | ||
|
|
||
| In VSCode: Go to the extensions menu, and look for `Jayvee`. The version is then displayed on the information page of the extension. |
There was a problem hiding this comment.
| In VSCode: Go to the extensions menu, and look for `Jayvee`. The version is then displayed on the information page of the extension. | |
| Go to the extensions menu, and look for `Jayvee`. The version is then displayed on the information page of the extension. |
apps/docs/docs/user/intro/intro.md
Outdated
| 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. | ||
|
|
||
| IMPORTANT: If a new Jayvee update is available, you need to update your VSCode extension for Jayvee as well. | ||
|
|
||
| More details on updating can be found [here](./update.md). | ||
|
|
||
| ```bash | ||
| npm install -g @jvalue/jayvee-interpreter | ||
| ``` |
There was a problem hiding this comment.
The point of this was to move all the update docs to one place, not keep it around in two places. So here, please just link to the update page and remove the rest. E.g.
| 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. | |
| IMPORTANT: If a new Jayvee update is available, you need to update your VSCode extension for Jayvee as well. | |
| More details on updating can be found [here](./update.md). | |
| ```bash | |
| npm install -g @jvalue/jayvee-interpreter | |
| ``` | |
| Details about how to update Jayvee and the VSCode extension can be found [here](./update.md). |
Tagged @georg-schwarz for a review as well. |
|
Ah, I note this branch has conflicts with the main branch. You'll need to rebase it on main (or merge main into this) before we can merge @OmarFourati |
|
Should be now updated and main is merged. |
apps/docs/docs/user/intro/intro.md
Outdated
| @@ -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)). | |||
There was a problem hiding this comment.
I think this should be reverted/combined again, we decided to link to the examples in the docs, not on github.
| 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)). | |
| 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)). |
|
Nice, thank you. I'll merge this very soon after next weeks MADE lecture just to make sure no change happens with the docs until then :). |
Description:
Updating jayvee through npm wasn't enough to have it fully functionning in VS Code. An update of the extension has to be done as well. This information was not present anywhere.
Solution
Add this information to the "update" part of the jayvee introduction
Related to #477.