From 2559a17277d26820c12a74507d7fa013e95c5f7c Mon Sep 17 00:00:00 2001 From: Seweryn Kras Date: Thu, 11 Jul 2024 10:33:15 +0200 Subject: [PATCH] docs: update examples directory structure --- docs/FEATURES.md | 27 +++++++++--------- .../{advanced => core-api}/manual-pools.ts | 0 .../{advanced => core-api}/override-module.ts | 0 examples/{advanced => core-api}/scan.ts | 0 .../{advanced => core-api}/step-by-step.ts | 0 .../advanced/local-image/Dockerfile | 0 .../advanced/local-image/alpine.gvmi | Bin .../advanced/local-image/serveLocalGvmi.ts | 0 .../advanced/payment-filters.ts | 0 .../advanced/proposal-filter.ts | 0 .../advanced/proposal-predefined-filter.ts | 0 .../advanced/proposal-selector.ts | 0 .../advanced/reuse-allocation.ts | 0 .../advanced/setup-and-teardown.ts | 0 examples/{ => rental-model}/basic/events.ts | 0 examples/{ => rental-model}/basic/many-of.ts | 0 examples/{ => rental-model}/basic/one-of.ts | 0 .../basic/run-and-stream.ts | 0 examples/{ => rental-model}/basic/transfer.ts | 0 examples/{ => rental-model}/basic/vpn.ts | 0 20 files changed, 13 insertions(+), 14 deletions(-) rename examples/{advanced => core-api}/manual-pools.ts (100%) rename examples/{advanced => core-api}/override-module.ts (100%) rename examples/{advanced => core-api}/scan.ts (100%) rename examples/{advanced => core-api}/step-by-step.ts (100%) rename examples/{ => rental-model}/advanced/local-image/Dockerfile (100%) rename examples/{ => rental-model}/advanced/local-image/alpine.gvmi (100%) rename examples/{ => rental-model}/advanced/local-image/serveLocalGvmi.ts (100%) rename examples/{ => rental-model}/advanced/payment-filters.ts (100%) rename examples/{ => rental-model}/advanced/proposal-filter.ts (100%) rename examples/{ => rental-model}/advanced/proposal-predefined-filter.ts (100%) rename examples/{ => rental-model}/advanced/proposal-selector.ts (100%) rename examples/{ => rental-model}/advanced/reuse-allocation.ts (100%) rename examples/{ => rental-model}/advanced/setup-and-teardown.ts (100%) rename examples/{ => rental-model}/basic/events.ts (100%) rename examples/{ => rental-model}/basic/many-of.ts (100%) rename examples/{ => rental-model}/basic/one-of.ts (100%) rename examples/{ => rental-model}/basic/run-and-stream.ts (100%) rename examples/{ => rental-model}/basic/transfer.ts (100%) rename examples/{ => rental-model}/basic/vpn.ts (100%) diff --git a/docs/FEATURES.md b/docs/FEATURES.md index 41be52ba0..a3d996b19 100644 --- a/docs/FEATURES.md +++ b/docs/FEATURES.md @@ -16,7 +16,6 @@ - [Setup and teardown methods](#setup-and-teardown-methods) - [Market scan](#market-scan) - [Read more](#read-more) - ## Streaming command results @@ -39,7 +38,7 @@ remoteProcess.stdout.on("data", (data) => console.log("stdout>", data)); await remoteProcess.waitForExit(); ``` -[Check the full example](../examples/basic/run-and-stream.ts) +[Check the full example](../examples/rental-model/basic/run-and-stream.ts) ## File transfer @@ -55,7 +54,7 @@ await exe console.log(await readFile("./results.txt", { encoding: "utf-8" })); ``` -[Check the full example](../examples/basic/transfer.ts) +[Check the full example](../examples/rental-model/basic/transfer.ts) ## VPN @@ -72,7 +71,7 @@ await exe1 .then((res) => console.log(`Response from provider: ${exe1.provider.name} (ip: ${exe1.getIp()})`, res.stdout)); ``` -[Check the full example](../examples/basic/vpn.ts) +[Check the full example](../examples/rental-model/basic/vpn.ts) ## Events @@ -85,7 +84,7 @@ glm.payment.events.on("invoiceAccepted", (invoice) => { }); ``` -[Check the full example](../examples/basic/events.ts) +[Check the full example](../examples/rental-model/basic/events.ts) ## Custom filters @@ -103,10 +102,10 @@ const order: MarketOrderSpec = { }; ``` -[Check the full example](../examples/advanced/proposal-filter.ts) +[Check the full example](../examples/rental-model/advanced/proposal-filter.ts) We have also prepared a set of predefined filters for common -use-cases. [Check out the example with predefined filters here](../examples/advanced/proposal-predefined-filter.ts) +use-cases. [Check out the example with predefined filters here](../examples/rental-model/advanced/proposal-predefined-filter.ts) ## Custom ranking of proposals @@ -132,7 +131,7 @@ const order: MarketOrderSpec = { }; ``` -[Check the full example](../examples/advanced/proposal-selector.ts) +[Check the full example](../examples/rental-model/advanced/proposal-selector.ts) ## Uploading local images to the provider @@ -150,7 +149,7 @@ const order: MarketOrderSpec = { }; ``` -[Check the full example](../examples/advanced//local-image/) +[Check the full example](../examples/rental-model/advanced/local-image/) ## Setup and teardown methods @@ -173,7 +172,7 @@ const pool = await glm.manyOf({ }); ``` -[Check the full example](../examples/advanced/setup-and-teardown.ts) +[Check the full example](../examples/rental-model/advanced/setup-and-teardown.ts) ## Market scan @@ -194,12 +193,12 @@ await glm.market }); ``` -[Check the full example](../examples/advanced/scan.ts) +[Check the full example](../examples/core-api/scan.ts) ## Read more If you wish to learn more about how the SDK functions under the hood, please check out our more advanced examples: -- [Creating pools manually](./.../examples/advanced/manual-pools.ts) -- [Performing all market operations manually](./.../examples/advanced/step-by-step.ts) -- [(for library authors) Override internal module](./.../examples/advanced/override-module.ts) +- [Creating pools manually](../examples/core-api/manual-pools.ts) +- [Performing all market operations manually](../examples/core-api/step-by-step.ts) +- [(for library authors) Override internal module](../examples/core-api/override-module.ts) diff --git a/examples/advanced/manual-pools.ts b/examples/core-api/manual-pools.ts similarity index 100% rename from examples/advanced/manual-pools.ts rename to examples/core-api/manual-pools.ts diff --git a/examples/advanced/override-module.ts b/examples/core-api/override-module.ts similarity index 100% rename from examples/advanced/override-module.ts rename to examples/core-api/override-module.ts diff --git a/examples/advanced/scan.ts b/examples/core-api/scan.ts similarity index 100% rename from examples/advanced/scan.ts rename to examples/core-api/scan.ts diff --git a/examples/advanced/step-by-step.ts b/examples/core-api/step-by-step.ts similarity index 100% rename from examples/advanced/step-by-step.ts rename to examples/core-api/step-by-step.ts diff --git a/examples/advanced/local-image/Dockerfile b/examples/rental-model/advanced/local-image/Dockerfile similarity index 100% rename from examples/advanced/local-image/Dockerfile rename to examples/rental-model/advanced/local-image/Dockerfile diff --git a/examples/advanced/local-image/alpine.gvmi b/examples/rental-model/advanced/local-image/alpine.gvmi similarity index 100% rename from examples/advanced/local-image/alpine.gvmi rename to examples/rental-model/advanced/local-image/alpine.gvmi diff --git a/examples/advanced/local-image/serveLocalGvmi.ts b/examples/rental-model/advanced/local-image/serveLocalGvmi.ts similarity index 100% rename from examples/advanced/local-image/serveLocalGvmi.ts rename to examples/rental-model/advanced/local-image/serveLocalGvmi.ts diff --git a/examples/advanced/payment-filters.ts b/examples/rental-model/advanced/payment-filters.ts similarity index 100% rename from examples/advanced/payment-filters.ts rename to examples/rental-model/advanced/payment-filters.ts diff --git a/examples/advanced/proposal-filter.ts b/examples/rental-model/advanced/proposal-filter.ts similarity index 100% rename from examples/advanced/proposal-filter.ts rename to examples/rental-model/advanced/proposal-filter.ts diff --git a/examples/advanced/proposal-predefined-filter.ts b/examples/rental-model/advanced/proposal-predefined-filter.ts similarity index 100% rename from examples/advanced/proposal-predefined-filter.ts rename to examples/rental-model/advanced/proposal-predefined-filter.ts diff --git a/examples/advanced/proposal-selector.ts b/examples/rental-model/advanced/proposal-selector.ts similarity index 100% rename from examples/advanced/proposal-selector.ts rename to examples/rental-model/advanced/proposal-selector.ts diff --git a/examples/advanced/reuse-allocation.ts b/examples/rental-model/advanced/reuse-allocation.ts similarity index 100% rename from examples/advanced/reuse-allocation.ts rename to examples/rental-model/advanced/reuse-allocation.ts diff --git a/examples/advanced/setup-and-teardown.ts b/examples/rental-model/advanced/setup-and-teardown.ts similarity index 100% rename from examples/advanced/setup-and-teardown.ts rename to examples/rental-model/advanced/setup-and-teardown.ts diff --git a/examples/basic/events.ts b/examples/rental-model/basic/events.ts similarity index 100% rename from examples/basic/events.ts rename to examples/rental-model/basic/events.ts diff --git a/examples/basic/many-of.ts b/examples/rental-model/basic/many-of.ts similarity index 100% rename from examples/basic/many-of.ts rename to examples/rental-model/basic/many-of.ts diff --git a/examples/basic/one-of.ts b/examples/rental-model/basic/one-of.ts similarity index 100% rename from examples/basic/one-of.ts rename to examples/rental-model/basic/one-of.ts diff --git a/examples/basic/run-and-stream.ts b/examples/rental-model/basic/run-and-stream.ts similarity index 100% rename from examples/basic/run-and-stream.ts rename to examples/rental-model/basic/run-and-stream.ts diff --git a/examples/basic/transfer.ts b/examples/rental-model/basic/transfer.ts similarity index 100% rename from examples/basic/transfer.ts rename to examples/rental-model/basic/transfer.ts diff --git a/examples/basic/vpn.ts b/examples/rental-model/basic/vpn.ts similarity index 100% rename from examples/basic/vpn.ts rename to examples/rental-model/basic/vpn.ts