Updated deploy script - #2981
Conversation
47254e3 to
d698b08
Compare
|
Uh, maybe you should use a grammar and spelling checker for all the strings and documentation, there are quite a bunch of spelling mistakes I've spotted in them. |
|
Ya I am sorry about that, I did rush on the final documentation because it was late and I was going on a trip the next day, plus I have dyslexia, so I’m not really good at spelling in the first place. I’ll look it over. I don’t have alot of time this or next week, but I’ll try to get around to it, and if not, I’ll get it done week after next. |
emmiegit
left a comment
emmiegit
left a comment
There was a problem hiding this comment.
My thoughts are that perhaps the script should be more "interactive documentation" and less "replacement for deploy.py", given that presently I feel like it is trying to do both and is weaker for it. A focus on one would make it more useful.
I also agree with Jochoi that there are a number of spelling etc. issues. I would make PR suggestions here, but I feel like the wider purpose of the script should be addressed first.
| ## Building and Running | ||
|
|
||
| **The helper script `install/local/deploy.py` is the primary way to manage a local Wikijump installation.** | ||
| **The helper script `install/local/deploy-helper.py` is the primary way to manage a local Wikijump installation.** |
There was a problem hiding this comment.
The direct utility is useful for invocation of commands, the other is useful for exploring options or newer developers:
| **The helper script `install/local/deploy-helper.py` is the primary way to manage a local Wikijump installation.** | |
| **You can use the helper script `install/local/deploy-help.py` to interactively navigate deployment for a local Wikijump installation.** Alternatively, if you're more familiar with Docker you can use `install/lock/deploy.py` directly. |
| ``` | ||
| and select the options you want to use | ||
|
|
||
| **for your first build, select the up option from the actions menu** |
There was a problem hiding this comment.
This seems kind of unnecessary. Either the reader takes the route of using the interactive script (where how to start a new instance is spelled out for them), or they want to learn more about the underlying Docker commands, in which case the original is what they would want to read.
| ``` | ||
| $ install/local/deploy-helper.py -s | ||
| ``` | ||
| **you can also use --skip instead of -s** |
There was a problem hiding this comment.
Hmm, if people want to skip over options in the interactive helper, maybe the point of the helper should be changed to providing guidance on how to run different commands?
So you navigate the menu to find a thing you want to do (and haven't done before), and can run it like that, but it also shows you the deploy.py / Docker command for it, so you can just run that in the future.
There was a problem hiding this comment.
It does do that now, it prints the command and asks for confirmation, and then prints it again.
|
I do see your point, but the reason I made the -s option was because I personally find it easier to just hit down arrow a couple of times then to add the docker command to the end of the other script. As it stands, I don’t even use the original script, because it’s just easier for me to use normal docker compose, with a little config stuff(sudo context is not so use, chdir isn’t really relevant when skipping the script, and you can get dev bindings by default with a little one time bashrc config. Maybe I’ll make a script for that). I do want to know, how hard was getting the dependencies to work? I may create pre compiled binaries if it’s hard |
3 participants
this added a menu based deployment script using python-questionary, which is an outside dependecy. it is incldued in pip and most other package managers though.