From 6a94f2971551582f2133b6643fe58da9702f5fb4 Mon Sep 17 00:00:00 2001 From: olapinska Date: Mon, 8 Oct 2018 11:42:48 +0200 Subject: [PATCH 1/7] chore(docs): remove registry --- docs/cheatsheet/web/index.html | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/docs/cheatsheet/web/index.html b/docs/cheatsheet/web/index.html index 21000146..d3b08307 100644 --- a/docs/cheatsheet/web/index.html +++ b/docs/cheatsheet/web/index.html @@ -492,10 +492,6 @@

Initiate project

# init with given instance nam s init -i -

Login to/register Syncano account

- 
npx s login
-

Logout (delete account keys from this computer)

- 
npx s logout

Attach project to the chosen Instance

npx s attach --instance my_instance_name
@@ -536,9 +532,6 @@

List Sockets

Socket details

npx s list <socket name>
-

Adding socket from the Sockets Registry (last version)

- 
npx s add <socket name>
-

Remove Socket

npx s remove <socket name>
@@ -559,19 +552,6 @@

Change single configuration option

npx s config-set <socket name> <option name> <value>
-

Registry

- -

Search for Sockets

- 
npx s search <keyword>
- -

Submit your Socket to the registry

- 
npx s submit  <socket name>
-
-# bump version of the Socket (e.g. major, minor, patch)
-s submit  <socket name> -b patch
- -

Make you private Socket public

- 
npx s publish <socket name>

Hosting

From c0d956a368b36e0ad83f34e27ce9fd4d87f48061 Mon Sep 17 00:00:00 2001 From: olapinska Date: Mon, 8 Oct 2018 12:19:11 +0200 Subject: [PATCH 2/7] chore(docs): remove registry --- docs/cheatsheet/web/index.html | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/cheatsheet/web/index.html b/docs/cheatsheet/web/index.html index d3b08307..59388b3c 100644 --- a/docs/cheatsheet/web/index.html +++ b/docs/cheatsheet/web/index.html @@ -492,8 +492,12 @@

Initiate project

# init with given instance nam s init -i +

Login to Syncano account

+ 
npx s login
+

Logout (delete account keys from this computer)

+ 
npx s logout

Attach project to the chosen Instance

- 
npx s attach --instance my_instance_name
+ 
npx s attach my_instance_name

Deploy

@@ -552,7 +556,6 @@

Change single configuration option

npx s config-set <socket name> <option name> <value>
-

Hosting

Add new hosting

From 5dbad6c4b042343d1c5dcac503f8624e93e7331b Mon Sep 17 00:00:00 2001 From: olapinska Date: Mon, 8 Oct 2018 12:41:35 +0200 Subject: [PATCH 3/7] chore(docs): remove registry --- docs/cheatsheet/web/index.html | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/cheatsheet/web/index.html b/docs/cheatsheet/web/index.html index 59388b3c..21000146 100644 --- a/docs/cheatsheet/web/index.html +++ b/docs/cheatsheet/web/index.html @@ -492,12 +492,12 @@

Initiate project

# init with given instance nam s init -i -

Login to Syncano account

+

Login to/register Syncano account

npx s login

Logout (delete account keys from this computer)

npx s logout

Attach project to the chosen Instance

- 
npx s attach my_instance_name
+ 
npx s attach --instance my_instance_name

Deploy

@@ -536,6 +536,9 @@

List Sockets

Socket details

npx s list <socket name>
+

Adding socket from the Sockets Registry (last version)

+ 
npx s add <socket name>
+

Remove Socket

npx s remove <socket name>
@@ -556,6 +559,20 @@

Change single configuration option

npx s config-set <socket name> <option name> <value>
+

Registry

+ +

Search for Sockets

+ 
npx s search <keyword>
+ +

Submit your Socket to the registry

+ 
npx s submit  <socket name>
+
+# bump version of the Socket (e.g. major, minor, patch)
+s submit  <socket name> -b patch
+ +

Make you private Socket public

+ 
npx s publish <socket name>
+

Hosting

Add new hosting

From 1bf4bfbc1ff81c558a92cb768b3dc8bb2fc59f59 Mon Sep 17 00:00:00 2001 From: olapinska Date: Mon, 8 Oct 2018 12:50:04 +0200 Subject: [PATCH 4/7] chore(docs): remove registry --- docs/cheatsheet/web/index.html | 19 +------------------ docs/docs/cli-reference/installation.md | 6 ------ docs/docs/common/changelog.md | 2 -- docs/docs/getting-started/sockets.md | 2 +- 4 files changed, 2 insertions(+), 27 deletions(-) diff --git a/docs/cheatsheet/web/index.html b/docs/cheatsheet/web/index.html index 21000146..63b88b5e 100644 --- a/docs/cheatsheet/web/index.html +++ b/docs/cheatsheet/web/index.html @@ -492,7 +492,7 @@

Initiate project

# init with given instance nam s init -i -

Login to/register Syncano account

+

Login to Syncano account

npx s login

Logout (delete account keys from this computer)

npx s logout
@@ -536,9 +536,6 @@

List Sockets

Socket details

npx s list <socket name>
-

Adding socket from the Sockets Registry (last version)

- 
npx s add <socket name>
-

Remove Socket

npx s remove <socket name>
@@ -559,20 +556,6 @@

Change single configuration option

npx s config-set <socket name> <option name> <value>
-

Registry

- -

Search for Sockets

- 
npx s search <keyword>
- -

Submit your Socket to the registry

- 
npx s submit  <socket name>
-
-# bump version of the Socket (e.g. major, minor, patch)
-s submit  <socket name> -b patch
- -

Make you private Socket public

- 
npx s publish <socket name>
-

Hosting

Add new hosting

diff --git a/docs/docs/cli-reference/installation.md b/docs/docs/cli-reference/installation.md index 546f1f80..28c7f6fd 100644 --- a/docs/docs/cli-reference/installation.md +++ b/docs/docs/cli-reference/installation.md @@ -41,12 +41,6 @@ npx syncano-cli config-set Configure a config option of a given Socket config-show Show config options of a Socket - Registry: - - search [options] [keyword] Search for a specific Socket in the Sockets Registry - submit [options] Submit a Socket to Socket Registry - publish [options] Publish a Socket in a Socket Registry - Other: hosting Manage your web assets and host them on Syncano diff --git a/docs/docs/common/changelog.md b/docs/docs/common/changelog.md index 19945912..71bc464b 100644 --- a/docs/docs/common/changelog.md +++ b/docs/docs/common/changelog.md @@ -113,8 +113,6 @@ Changelog: * mainly CLI reference ([0c06600b](https://github.com/Syncano/syncano-node-cli/commit/0c06600b)) * some new docs ([974d8674](https://github.com/Syncano/syncano-node-cli/commit/974d8674)) * **install:** recursive finding dependencies ([0d4fe3fb](https://github.com/Syncano/syncano-node-cli/commit/0d4fe3fb)) - * **registry:** publish, config ([6ea69ea5](https://github.com/Syncano/syncano-node-cli/commit/6ea69ea5)) - * **registry install:** new way of installing sockets from registry ([9cb0a801](https://github.com/Syncano/syncano-node-cli/commit/9cb0a801)) * **sentry:** refactoring of sentry reporting ([aed053dd](https://github.com/Syncano/syncano-node-cli/commit/aed053dd)) * **settings:** new yaml parser ([ab9cda74](https://github.com/Syncano/syncano-node-cli/commit/ab9cda74)) * **socket:** syncing sockets with deps ([54b9c5ac](https://github.com/Syncano/syncano-node-cli/commit/54b9c5ac)) diff --git a/docs/docs/getting-started/sockets.md b/docs/docs/getting-started/sockets.md index b882d432..bfa34376 100644 --- a/docs/docs/getting-started/sockets.md +++ b/docs/docs/getting-started/sockets.md @@ -17,7 +17,7 @@ A Syncano Socket has a clear purpose — whether it is sending an email, storing You can use Sockets that have already been created by other developers and stored in NPM. -You can also create your own Socket using the Syncano CLI. For more information check [Sockets](/building-sockets/basics) section. You can publish it to the Syncano Registry, so that other developers could also use it. This will help to create the ecosystem that everybody can be a part of and bring us closer to our vision of the autonomous developer. +You can also create your own Socket using the Syncano CLI. For more information check [Sockets](/building-sockets/basics) section. ## Exciting? Read more! From 8ba3b0c3c53e084ea16c3402d96aa128a9d59b9f Mon Sep 17 00:00:00 2001 From: olapinska Date: Tue, 9 Oct 2018 14:16:46 +0200 Subject: [PATCH 5/7] chore(docs): update quickstart --- docs/docs/getting-started/quickstart.md | 40 ++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/docs/docs/getting-started/quickstart.md b/docs/docs/getting-started/quickstart.md index 9c9bb701..65546cb9 100644 --- a/docs/docs/getting-started/quickstart.md +++ b/docs/docs/getting-started/quickstart.md @@ -1,6 +1,35 @@ # Quickstart Guide -To start using Syncano with your project follow the steps: +If you create **new project**, before start using Syncano, you should follow these steps: + +## Create folder to your project + +```sh +mkdir ~/my-project +``` + +and go to the created folder: + +```sh +cd ~/my-project +``` + +## Install npm - package manager for JavaScript + +```sh +npm install +``` + +## Inicialize empty project + +```sh +npm init +``` +You'll be asked for an `package name`, `version` , `description` , `git repository` , `keywords` , `author` and `license`. +You can use `npm init -y` command and press enter. The values will be accepted as default. + +
+To start using Syncano in **your project** follow these steps: ## Install the Syncano CLI in your project @@ -42,3 +71,12 @@ npx s list Try to call endpoints using browser or any HTTP Client. That's `it`! If you have any questions, log into our [Slack](https://syncano.io/#/slack-invite) and chat with the community. Happy coding! + + +## How to check the correctness of the socket? + +After the URL address add args from your socket: `?$firstname=your_name&lastname=your_last_name` and press enter: + +```sh + https://rough-star-5685.syncano.space/hello/hello/?$firstname=your_name&lastname=your_last_name +``` From 4e0074a3c18f3f39327d49753fbf88513e3a5e54 Mon Sep 17 00:00:00 2001 From: olapinska Date: Tue, 9 Oct 2018 14:49:27 +0200 Subject: [PATCH 6/7] Revert "chore(docs): update quickstart" This reverts commit 8ba3b0c3c53e084ea16c3402d96aa128a9d59b9f. --- docs/docs/getting-started/quickstart.md | 40 +------------------------ 1 file changed, 1 insertion(+), 39 deletions(-) diff --git a/docs/docs/getting-started/quickstart.md b/docs/docs/getting-started/quickstart.md index 65546cb9..9c9bb701 100644 --- a/docs/docs/getting-started/quickstart.md +++ b/docs/docs/getting-started/quickstart.md @@ -1,35 +1,6 @@ # Quickstart Guide -If you create **new project**, before start using Syncano, you should follow these steps: - -## Create folder to your project - -```sh -mkdir ~/my-project -``` - -and go to the created folder: - -```sh -cd ~/my-project -``` - -## Install npm - package manager for JavaScript - -```sh -npm install -``` - -## Inicialize empty project - -```sh -npm init -``` -You'll be asked for an `package name`, `version` , `description` , `git repository` , `keywords` , `author` and `license`. -You can use `npm init -y` command and press enter. The values will be accepted as default. - -
-To start using Syncano in **your project** follow these steps: +To start using Syncano with your project follow the steps: ## Install the Syncano CLI in your project @@ -71,12 +42,3 @@ npx s list Try to call endpoints using browser or any HTTP Client. That's `it`! If you have any questions, log into our [Slack](https://syncano.io/#/slack-invite) and chat with the community. Happy coding! - - -## How to check the correctness of the socket? - -After the URL address add args from your socket: `?$firstname=your_name&lastname=your_last_name` and press enter: - -```sh - https://rough-star-5685.syncano.space/hello/hello/?$firstname=your_name&lastname=your_last_name -``` From 0d7dc3bf969c873842416ad38155061d916e2f50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Olga=20=C5=81api=C5=84ska?= <31473427+olapinska@users.noreply.github.com> Date: Mon, 15 Oct 2018 09:18:35 +0200 Subject: [PATCH 7/7] Remove registry from docs --- docs/cheatsheet/web/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cheatsheet/web/index.html b/docs/cheatsheet/web/index.html index 63b88b5e..d25f949e 100644 --- a/docs/cheatsheet/web/index.html +++ b/docs/cheatsheet/web/index.html @@ -492,7 +492,7 @@

Initiate project

# init with given instance nam s init -i -

Login to Syncano account

+

Login to/register Syncano account

npx s login

Logout (delete account keys from this computer)

npx s logout