{"action":"created","issue":{"url":"https://api.github.com/repos/paritytech/fether/issues/493","repository_url":"https://api.github.com/repos/paritytech/fether","labels_url":"https://api.github.com/repos/paritytech/fether/issues/493/labels{/name}","comments_url":"https://api.github.com/repos/paritytech/fether/issues/493/comments","events_url":"https://api.github.com/repos/paritytech/fether/issues/493/events","html_url":"https://github.com/paritytech/fether/issues/493","id":430009408,"node_id":"MDU6SXNzdWU0MzAwMDk0MDg=","number":493,"title":"Doc upgrade or \"why so man semi-colons?\"","user":{"login":"stone212","id":26020999,"node_id":"MDQ6VXNlcjI2MDIwOTk5","avatar_url":"https://avatars0.githubusercontent.com/u/26020999?v=4","gravatar_id":"","url":"https://api.github.com/users/stone212","html_url":"https://github.com/stone212","followers_url":"https://api.github.com/users/stone212/followers","following_url":"https://api.github.com/users/stone212/following{/other_user}","gists_url":"https://api.github.com/users/stone212/gists{/gist_id}","starred_url":"https://api.github.com/users/stone212/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stone212/subscriptions","organizations_url":"https://api.github.com/users/stone212/orgs","repos_url":"https://api.github.com/users/stone212/repos","events_url":"https://api.github.com/users/stone212/events{/privacy}","received_events_url":"https://api.github.com/users/stone212/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2019-04-06T07:54:40Z","updated_at":"2019-04-06T10:25:39Z","closed_at":null,"author_association":"NONE","body":"Did a mariaDB expert write the doc? :)  Maybe you want to replace this:\r\n\r\n```\r\nsudo apt update;\r\nsudo apt install -y git nodejs npm curl;\r\ncurl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -;\r\napt-get install -y nodejs;\r\nsudo ln -s /usr/bin/nodejs /usr/bin/node;\r\ncurl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -;\r\necho \"deb https://dl.yarnpkg.com/debian/ stable main\" | sudo tee /etc/apt/sources.list.d/yarn.list;\r\nsudo apt-get update && sudo apt-get install yarn;\r\nsudo ln -s /usr/bin/yarn /usr/local/bin/yarn;\r\nyarn global add windows-build-tools;\r\n```\r\n\r\nWith this:\r\n\r\n```\r\n$ sudo apt update\r\n$ curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -\r\n$ sudo apt-get install -y nodejs\r\n$ sudo ln -s /usr/bin/nodejs /usr/bin/node (<-- might not be necessary)\r\n$ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -\r\n$ echo \"deb https://dl.yarnpkg.com/debian/ stable main\" | sudo tee /etc/apt/sources.list.d/yarn.list\r\n$ sudo apt-get update && sudo apt-get install yarn\r\n$ sudo ln -s /usr/bin/yarn /usr/local/bin/yarn\r\n```"},"comment":{"url":"https://api.github.com/repos/paritytech/fether/issues/comments/480493043","html_url":"https://github.com/paritytech/fether/issues/493#issuecomment-480493043","issue_url":"https://api.github.com/repos/paritytech/fether/issues/493","id":480493043,"node_id":"MDEyOklzc3VlQ29tbWVudDQ4MDQ5MzA0Mw==","user":{"login":"ltfschoen","id":6226175,"node_id":"MDQ6VXNlcjYyMjYxNzU=","avatar_url":"https://avatars0.githubusercontent.com/u/6226175?v=4","gravatar_id":"","url":"https://api.github.com/users/ltfschoen","html_url":"https://github.com/ltfschoen","followers_url":"https://api.github.com/users/ltfschoen/followers","following_url":"https://api.github.com/users/ltfschoen/following{/other_user}","gists_url":"https://api.github.com/users/ltfschoen/gists{/gist_id}","starred_url":"https://api.github.com/users/ltfschoen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ltfschoen/subscriptions","organizations_url":"https://api.github.com/users/ltfschoen/orgs","repos_url":"https://api.github.com/users/ltfschoen/repos","events_url":"https://api.github.com/users/ltfschoen/events{/privacy}","received_events_url":"https://api.github.com/users/ltfschoen/received_events","type":"User","site_admin":false},"created_at":"2019-04-06T10:25:39Z","updated_at":"2019-04-06T10:25:39Z","author_association":"CONTRIBUTOR","body":"Hi @stone212. Thanks for creating an issue!\r\n\r\nI added it that way because our time is precious. Adding a semi-colon at the end of each line is like adding a `&&` at the end of each line. It provides users with the convenience of being able to just copy/paste all those lines of code into terminal, press the enter key, and come back some time later after getting a coffee to find it's all installed. If there are any lines of code that you don't need then you just don't copy/paste them.\r\n\r\nIf you don't add a `;` or `&&` at the end of each line and you copy/paste all those lines of code into a terminal, it will only run the first command, so you'll have to waste time manually entering each command and waiting indefinitely for it to finish when you could be doing something better with your time.\r\n\r\nOthers may disagree, but I don't see any benefit to adding `$ ` at the start of each line. We're already using Markdown with bash/shell syntax highlighting, and you can't copy/paste multiple lines of code as conveniently.\r\n\r\nI would have liked to have moved this code into a bash script, but not everyone likes that approach, which I discovered in this PR (a shell script for a different repo) that wasn't merged https://github.com/paritytech/scripts/pull/56\r\n\r\nAs for the `(<-- might not be necessary)` line of code, I just left that there because I it may be necessary, and if it is, it may save the user from the mundane task of having to try and figure out the missing step. If it's not necessary I don't think it does any harm.\r\n\r\nSome users may be running Fether just after initially setting up their OS, hence the reason why I've provided the initial steps of installing dependencies like Git, cURL, etc.\r\n\r\nWe might be able to update the first four lines as follows:\r\n\r\n```bash\r\nsudo apt update;\r\nsudo apt install -y git curl;\r\ncurl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -;\r\nsudo apt-get install -y nodejs;\r\n```\r\n\r\nAlthough I personally prefer using Node Version Manager (NVM) and Yarn Version Manager (YVM), so we could replace the Node.js and Yarn setup steps with the following or similar:\r\n\r\n```bash\r\ncurl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash;\r\nsource ~/.bashrc;\r\ncommand -v nvm;\r\nnvm list;\r\nnvm install v11.13.0;\r\nnvm use v11.13.0;\r\n\r\ncurl -fsSL https://raw.githubusercontent.com/tophat/yvm/master/scripts/install.js | node\r\nsource ~/.yvm/yvm.sh\r\n\r\ncurl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -;\r\necho \"deb https://dl.yarnpkg.com/debian/ stable main\" | sudo tee /etc/apt/sources.list.d/yarn.list;\r\nsudo apt-get update;\r\nsudo apt-get install -y yarn;\r\nsudo ln -s /usr/bin/yarn /usr/local/bin/yarn;\r\nyvm list;\r\nyvm use 1.15.2;\r\n```\r\n"}}
{"actor":{"display_login":"ltfschoen"}}