Verified Commit 395f26a2 authored by Aral Balkan's avatar Aral Balkan
Browse files

Closes #137: Docs match readme for server start, stop, restart, etc.

parent 52be7532
......@@ -648,14 +648,14 @@ When you `serve` a site at `@hostname` or use the `enable` command, globally-tru
| Goal | Command |
| ----------------------------------------- | ------------------------------------------------------------- |
| Serve current folder as daemon | site enable |
| Install and serve current folder as daemon| site enable |
| Ditto & also ensure it can rsync via ssh | site enable --ensure-can-sync |
| Get status of daemon | site status |
| Start server | site start |
| Stop server | site stop |
| Restart server | site restart |
| Display server logs | site logs |
| Stop current daemon | site disable |
| Stop and uninstall current daemon | site disable |
#### General:
......
......@@ -195,15 +195,22 @@ class Help {
${ this.systemdExists ? `
Start-up daemon:
Serve current folder as daemon\t\t${prompt} ${appName} ${commandEnable}
Install & serve current folder as daemon\t${prompt} ${appName} ${commandEnable}
• Ditto & also ensure it can rsync via ssh\t${prompt} ${appName} ${commandEnable} ${optionEnsureCanSync}
• Get status of deamon\t\t\t${prompt} ${appName} ${commandStatus}
• Start server\t\t\t\t${prompt} ${appName} ${commandStart}
• Stop server\t\t\t\t${prompt} ${appName} ${commandStop}
• Restart server\t\t\t\t${prompt} ${appName} ${commandRestart}
• Display server logs\t\t\t${prompt} ${appName} ${commandLogs}
• Stop current daemon\t\t\t${prompt} ${appName} ${commandDisable}
• Stop and uninstall current daemon\t\t${prompt} ${appName} ${commandDisable}
` : ''}
${heading('Static site generation:')}
• Create a new Hugo site\t\t\t${prompt} ${appName} ${commandHugo} ${argument('new site demo')}
${heading('General:')}
• Check for updates and update if found\t${prompt} ${appName} ${commandUpdate}
${ this.isWindows ? `
${heading('Windows-specific notes:')}
......
......@@ -458,16 +458,23 @@ test('[commands] help', t => {
Start-up daemon:
Serve current folder as daemon ▶ site enable
Install & serve current folder as daemon ▶ site enable
• Ditto & also ensure it can rsync via ssh ▶ site enable --ensure-can-sync
• Get status of deamon ▶ site status
• Display server logs ▶ site logs
• Stop current daemon ▶ site disable
• Get status of deamon ▶ site status
• Start server ▶ site start
• Stop server ▶ site stop
• Restart server ▶ site restart
• Display server logs ▶ site logs
• Stop and uninstall current daemon ▶ site disable
Static site generation:
• Create a new Hugo site ▶ site hugo new site demo
General:
• Check for updates and update if found ▶ site update
For further information, please see https://sitejs.org
`)
......@@ -547,6 +554,10 @@ test('[commands] help', t => {
Static site generation:
• Create a new Hugo site ▶ site hugo new site demo
General:
• Check for updates and update if found ▶ site update
Linux-specific notes:
- Production use is not available on this Linux distribution as systemd does not exist.
- For production use, we currently recommend using Ubuntu 18.04 or 20.04 LTS.
......@@ -631,6 +642,10 @@ test('[commands] help', t => {
Static site generation:
• Create a new Hugo site ▶ site hugo new site demo
General:
• Check for updates and update if found ▶ site update
Windows-specific notes:
- Unlike Linux and macOS, you must use quotation marks around @localhost and @hostname.
- Production use is not available on Windows as it requires Linux with systemd.
......@@ -713,6 +728,10 @@ test('[commands] help', t => {
Static site generation:
• Create a new Hugo site ▶ site hugo new site demo
General:
• Check for updates and update if found ▶ site update
Mac-specific notes:
- Production use is not available on macOS as it requires Linux with systemd.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment