README.rst: Add Build and Development instructions #153
Conversation
|
Yea i followed these steps and they were working perfectly fine for me, Also i have send these instructions to one of my friends to cross verify it that whether he is facing any issues during installation of coala-html on Ubuntu or not, but he didn’t faced any issues 🙂 |
KVGarg
force-pushed
the
build_development_instructions
branch
from
c87bb33
to
8a05f53
Compare
KVGarg
force-pushed
the
build_development_instructions
branch
from
8a05f53
to
7e2ebcd
Compare
|
@frextrite @shashank-b Please review the latest commit |
|
@frextrite reply to comment |
KVGarg
force-pushed
the
build_development_instructions
branch
3 times, most recently
from
f68f813
to
d65bf6b
Compare
|
@frextrite @shashank-b can you guys help me out in solving this issue as it is related to this issue only ? |
KVGarg
force-pushed
the
build_development_instructions
branch
from
d65bf6b
to
a03b3fa
Compare
KVGarg
force-pushed
the
build_development_instructions
branch
3 times, most recently
from
4055e4a
to
e66a039
Compare
|
@li-boxuan @frextrite @shashank-b Kindly review latest commits, tq |
KVGarg
force-pushed
the
build_development_instructions
branch
from
e66a039
to
5ed25ad
Compare
README.rst
Outdated
|
|
||
| :: | ||
|
|
||
| $ sudo chown -R $USER:$GROUP ~/.config/configstore |
There was a problem hiding this comment.
Sorry if my review repeats things already in old reviews,...
This step is a non-standard step -- there is no reason why this directory should have strange permissions.
The problem is possibly caused by sudo npm install -g bower, but I am not sure about that.
Anyways ... you added it here for a reason ... i'd love to know why, so we can look at how to avoid it.
There was a problem hiding this comment.
Actually, when we try to run coala-html --dir ./coala_test_results it install the bower components that are required to build up a static website and it is a package used by AngularJS, that is possible only if it has write access to configstore
and, to install bower using npm it needs write access that's why i used sudo
There was a problem hiding this comment.
Using asdf solves those sudo problems.
There was a problem hiding this comment.
Ok, will try out them and if everything goes well, will use asdf.
There was a problem hiding this comment.
@jayvdb asdf has solved the problem of sudo npm install -g bower but wasn't able to solve the problem sudo chown -R $USER:$GROUP ~/.config/configstore
It still need permissons to access the files in the configstore folder.
npm suggests a ownership command sudo chown -R $USER:$(id -gn $USER) ~/.config/configstore, we can change the above command to this one
There was a problem hiding this comment.
@KVGarg , if you never run 'sudo' in your install steps, the chown is not necessary.
redo your steps without running 'sudo'. and show me errors that you can not fix. chown is not the solution - it is a workaround recommended by npm because they do not recommend asdf, and so their workaround is not acceptable to us.
There was a problem hiding this comment.
@jayvdb I'm wondering that earlier it wasn't getting installed due to write access to configstore but now it is getting installed easily without even using sudo. Removing this instruction from guide.
README.rst
Outdated
| :: | ||
|
|
||
| $ sudo apt-get install curl python-software-properties | ||
| $ curl -sL https://deb.nodesource.com/setup_11.x | sudo bash - |
There was a problem hiding this comment.
doesnt ubuntu have node? Above a "Node.js PPA" is mentioned, but this is not a PPA.
We should give a PPA install method.
Also for generic Linux, and even Windows, I am now recommending that we use @asdf-vm in our instructions, as it allows installing of node and python and anything else we need. (not sure about bower / lets check that)
There was a problem hiding this comment.
This section is meant for Linux users, sorry my bad.
I will change to Linux in both the headings where it is written for Ubuntu/Linux users.
PPA install method
Should I change above heading to this one ?
There was a problem hiding this comment.
doesnt ubuntu have node?
Need to run sudo apt install nodejs to install nodejs
There was a problem hiding this comment.
@jayvdb And, should I add installation instructions according to @asdf-vm in current instructions or a provide a link somewhere in instruction either at end or at the beginning of instructions ?
There was a problem hiding this comment.
A link to official upstream pages is better.
There was a problem hiding this comment.
I have added link for installing nodejs via asdf-vm. Will it work? or should I add offical nodejs website link for installing it ?
KVGarg
force-pushed
the
build_development_instructions
branch
from
5ed25ad
to
c58beff
Compare
This comment has been minimized.
This comment has been minimized.
KVGarg
force-pushed
the
build_development_instructions
branch
from
c58beff
to
c310892
Compare
KVGarg
force-pushed
the
build_development_instructions
branch
from
c310892
to
f8d84ef
Compare
KVGarg
force-pushed
the
build_development_instructions
branch
from
f8d84ef
to
0092680
Compare
KVGarg
force-pushed
the
build_development_instructions
branch
from
0092680
to
ac3d514
Compare
KVGarg
force-pushed
the
build_development_instructions
branch
from
ac3d514
to
4e05c4f
Compare
The commit adds instructions for running coala-html on a local system.
Closes #135