Docs/canary #111
Docs/canary #111
Conversation
docs/cheatsheet/web/index.html
Outdated
| <pre><code class="lang-bash">npm install --global yarn | ||
| npm install -g syncano-cli</code></pre> | ||
| <pre><code class="lang-bash"> | ||
| npm install -g @syncano/cli</code></pre> |
There was a problem hiding this comment.
Proper way now is to install CLI as a private dependency for your project - so it is not a global install.
|
|
||
| * You have `node` v7.0.0+ installed and `yarn` at v0.17.10+ (as we use it for development) | ||
| * You are familiar with `npm`/`yarn` | ||
| * You have `node` v7.0.0+ installed (as we use it for development) |
There was a problem hiding this comment.
Take a look into main package.json and engines requirements.
There was a problem hiding this comment.
we're removing this section from cookbook, but I'll update corresponding file in docs
docs/docs/_coverpage.md
Outdated
| <span class="lite">⬢</span> $ npm install -g yarn<br /> | ||
| <span class="lite">⬢</span> $ npm install -g syncano-cli<br /> | ||
| <p> | ||
| <span class="lite">⬢</span> $ npm install -g @syncano/cli<br /> |
| - [Cookbook](https://cookbook.syncano.io/#/) | ||
|
|
||
| - Canary version | ||
| - [v. 0.6](https://syncano.github.io/syncano-node-cli/#/) |
There was a problem hiding this comment.
syncano-node-cli is an old CLI syncano-node is our current repo.
There was a problem hiding this comment.
it's a link to old docs, not to the current repo
docs/docs/building-sockets/basics.md
Outdated
| You can use a hot deployment feature which watches your socket's files and deploys it on change (you need to deploy your socket first in order to use this feature). If no socket name is provided it watches all of your sockets. | ||
|
|
||
| ```sh | ||
| syncano-cli hot <socketname> |
There was a problem hiding this comment.
To use local version of CLI we should use npx syncano-cli <command>. I want to find the way to have some alias no npx will not be necessary but so far it is (to run local executables).
| ``` | ||
|
|
||
| If `syncano-server` is not listed there you can use `yarn` to install it (you have to be inside Socket folder): | ||
| If `syncano-server` is not listed there you can use `npm` to install it (you have to be inside Socket folder): |
There was a problem hiding this comment.
syncano-server is now @syncano/core.
Codecov Report
@@ Coverage Diff @@
## master #111 +/- ##
=========================================
- Coverage 34.48% 33.38% -1.1%
=========================================
Files 118 90 -28
Lines 4588 3795 -793
=========================================
- Hits 1582 1267 -315
+ Misses 3006 2528 -478 |
|
LGTM |
docs/docs/getting-started/intro.md
Outdated
| ### The Syncano CLI | ||
|
|
||
| Use the Syncano Command Line interface (CLI) to manage the whole build and deploy process. You can get it from npm with `npm install syncano-cli -g` command (it requires Node and Yarn to be installed). It's a powerful terminal tool, so you won't have to leave your working environment. The whole synchronization and deployment process happens automatically and seamlessly. | ||
| Use the Syncano Command Line interface (CLI) to manage the whole build and deploy process. You can get it from npm with `npm install @syncano/cli -g` command (it requires Node to be installed). It's a powerful terminal tool, so you won't have to leave your working environment. The whole synchronization and deployment process happens automatically and seamlessly. |
| npx syncano-cli init | ||
| ``` | ||
|
|
||
| > There's shortcut for `syncano-cli` - you can simple type `s` |
docs/docs/getting-started/windows.md
Outdated
|
|
||
| For more comfortable development process on Microsoft Windows, please install Windows Subsystem for Linux. You can find a detailed guide how to do this here: [docs.microsoft.com/en-us/windows/wsl/install-win10](https://docs.microsoft.com/en-us/windows/wsl/install-win10). | ||
|
|
||
| You will also need a working nodejs enviroment. Please follow this guide: [hackernoon.com/running-nodejs-on-linux-on-windows-88bd12993bae](https://hackernoon.com/running-nodejs-on-linux-on-windows-88bd12993bae). No newline at end of file |
There was a problem hiding this comment.
s/enviroment/environment
| It will be submitted to npm with `@canary` tag. From there we will merge it into `master` that will bump proper version of `CLI`. | ||
|
|
||
| #### Waiting for review | ||
|
|
There was a problem hiding this comment.
The parts below about commiting and the release process are no longer valid
There was a problem hiding this comment.
@adamwardecki any suggestions on this? how does it look now?
There was a problem hiding this comment.
- The whole section about commiting should be removed
- we don't use commitizen, although commits should have a conventional commit style https://conventionalcommits.org/
- we don't use semantic release. seems that lerna handles the release process (It's @mkucharz who configured the set up, so he'll be able to tell more about it)
I see this section is in two places docs/common and cookbook/common
|
@maciejkorsan I think that maybe we should try to close it soon ;) |
|
@mkucharz have a look |
|
@maciejkorsan let's do it! :) |
4 participants
No description provided.