-
Notifications
You must be signed in to change notification settings - Fork 0
Add cheatsheet. #131
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
Merged
Merged
Add cheatsheet. #131
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
ef355ed
Add cheatsheet.
mariacarmina a1ed3d9
Update sections.
mariacarmina b739174
Tweaks.
mariacarmina 74dcade
Update resources.
mariacarmina 522d516
Merge branch 'main' into feature/cheatsheet
giurgiur99 0f2903f
fixes cheatsheet
giurgiur99 503bf6e
Readme update
giurgiur99 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 hidden or 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
This file contains hidden or 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,74 @@ | ||
| # 🌊 Ocean Protocol VS Code Extension — User Cheatsheet | ||
|
|
||
| Run **Compute-to-Data jobs** directly from VS Code. | ||
|
|
||
| --- | ||
|
|
||
| ## ✅ Requirements | ||
|
|
||
| - VS Code **v1.96.0 or higher** | ||
|
|
||
| --- | ||
|
|
||
| ## 📦 Installation | ||
|
|
||
| 1. Install from [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=OceanProtocol.ocean-protocol-vscode-extension). | ||
| 2. Open the **Ocean Protocol** panel (left Activity Bar). | ||
|
|
||
| --- | ||
|
|
||
| ## ▶️ Run your first compute job | ||
|
|
||
| 1. Create a **new project folder**. | ||
| 2. Pick a **parent directory** for your project. This is where your algo and compute results will be saved. | ||
| 3. Find a name for your new project. Default is `new-compute-job`. | ||
| 4. Pick your favorite language for your algorithm. At the moment, we support **Python** and **JavaScript**. | ||
| 5. Explore your newly created project. It will have a `Dockerfile`, dependencies file and an algorithm. | ||
| 6. Run your first compute job by clicking **Start FREE Compute Job**. | ||
| 7. Watch logs & job status in the **Output console**. | ||
| 8. When finished, results and logs will be saved in your project folder under the `results` folder. | ||
|
|
||
| --- | ||
|
|
||
| ## ⚡ Tips | ||
|
|
||
| - **Free compute** uses an environment with minimal resources. | ||
| - Resources are displayed under the **Setup** dropdown. | ||
| - Whenever you want to get more resources, you can upgrade to a paid compute job. | ||
| - Go to **Configure Compute** to change your compute settings. | ||
| - Logs & errors show up in the **Output console**. | ||
| - If no dockerfile is provided, you can use your own docker image and tag. | ||
|
|
||
| --- | ||
|
|
||
| ## 🛠️ Troubleshooting | ||
|
|
||
| - ❌ Job cannot start → check node status. (Under the **Setup** dropdown, press the **Check** button) | ||
| - ❌ Job not running → check Node URL. | ||
| - ❌ Not enough funds → use **Configure Compute** to change your compute settings. | ||
| - Always check **extension logs** in Output. Logs are also saved in your project folder under the `logs` folder. | ||
|
|
||
| --- | ||
|
|
||
| ## 📦 Advanced Setup | ||
|
|
||
| - Custom Docker image/tag. Only if no dockerfile is provided in your project folder. | ||
| - Auth Token. This is auto-generated once you configure your compute settings. | ||
|
|
||
| --- | ||
|
|
||
| ## 🔄 Workflow Summary | ||
|
|
||
| | Step | Action | | ||
| | ---- | ------------------------------------------------------------ | | ||
| | 1 | Create a new project folder / Select existing project folder | | ||
| | 2 | Click **Start Compute Job** | | ||
| | 3 | Monitor logs & job status | | ||
| | 4 | Check results in your project folder | | ||
|
|
||
| --- | ||
|
|
||
| ## 📚 Resources | ||
|
|
||
| - [Ocean Protocol Docs](https://docs.oceanprotocol.com/developers/vscode) | ||
| - [GitHub Repo](https://github.com/oceanprotocol/vscode-extension) | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
Uh oh!
There was an error while loading. Please reload this page.