Permalink
Browse files

[faq] add changing application names

  • Loading branch information...
1 parent 0024aa5 commit 5a28d8f415324898e93fba37619d3a8ca857226a @Swaagie Swaagie committed Mar 26, 2013
Showing with 43 additions and 32 deletions.
  1. +16 −6 content/a-quickstart/faq.md
  2. +17 −17 content/jitsu/deploy.md
  3. +10 −9 content/jitsu/index.md
@@ -258,17 +258,27 @@ and only if everything went ok, so a failed deploy does not equate to down time.
## Why is the subdirectory or its content not deployed to Nodejitsu?
-Execute `npm pack` inside your application and make sure that the resulting
-package includes the file. Nodejitsu uses the same command when deploying
+Execute `npm pack` inside your application and make sure that the resulting
+package includes the file. Nodejitsu uses the same command when deploying
your app.
-In case it is not included in the package, you should look into your
-`gitignore` and/or `.npmignore` files to ensure that the folder or
-contained files are not ignored. Note that any files/folders starting with
-`.` like `.DS_Store` are ignored by default and some special ones like `.git`
+In case it is not included in the package, you should look into your
+`gitignore` and/or `.npmignore` files to ensure that the folder or
+contained files are not ignored. Note that any files/folders starting with
+`.` like `.DS_Store` are ignored by default and some special ones like `.git`
cannot be unignored since npm prevents that.
To explicitly unignore a file use `!filename` inside either `.gitignore` or
`.npmignore`.
+---
+
+## How can I change the name of my application?
+
+Changing the name is possible, however there's just one caveat. After the name
+change you will loose previous snapshots and other configured settings.
+
+To change the application name do `jitsu destroy`, confirm and finally redeploy
+with `jitsu deploy`. Both commands must be executed within the project folder.
+
[meta:title]: <> (FAQ)
View
@@ -1,7 +1,7 @@
# Deploying your application
-Deploying your application is easy, it should only take a few seconds.
-`jitsu deploy` can be executed from the root of the application. This is where
+Deploying your application is easy, it should only take a few seconds.
+`jitsu deploy` can be executed from the root of the application. This is where
the *package.json* is located. Deployment will iterate through the following
steps.
@@ -11,28 +11,28 @@ steps.
4. Stops the application (if necessary)
5. Starts the application
-If you deploy for the first time, you'll be prompted for a subdomain and
+If you deploy for the first time, you'll be prompted for a subdomain and
confirm the changes to [package.json][package]. By default your username will be
prepended before the application name. After a succesful deploy `Nodejitsu ok`
will be returned.
```
-info: Welcome to Nodejitsu [user]
+info: Welcome to Nodejitsu [user]
info: jitsu v0.12.8, node v0.8.22
info: It worked if it ends with Nodejitsu ok
info: Executing command deploy
-warn:
+warn:
warn: The package.json file is missing required fields:
-warn:
+warn:
warn: Subdomain name
-warn:
+warn:
warn: Prompting user for required fields.
warn: Press ^C at any time to quit.
-warn:
-prompt: Subdomain name: (subdomain)
+warn:
+prompt: Subdomain name: (subdomain)
warn: About to write /var/www/test/helloworld/package.json
...
-prompt: Is this ok?: (yes)
+prompt: Is this ok?: (yes)
info: Skipping require-analyzer because noanalyze option is set
info: Checking app availability nodeapps-helloworld
info: Creating app nodeapps-helloworld
@@ -48,7 +48,7 @@ info: Nodejitsu ok
## Repeated deployments
After an initial deploy you can redeploy as often as you would like. Note
-however that `jitsu` will ask to increase the package build version, e.g the
+however that `jitsu` will ask to increase the package build version, e.g the
`x` in `0.0.z-x` will be incremented. A manual increase of the patch `z`
version will skip the step below and immediatly deploy your application.
@@ -65,11 +65,11 @@ warn: About to write /var/www/test/helloworld/package.json
...
data: version: '0.2.2-1',
...
-prompt: Is this ok?: (yes)
+prompt: Is this ok?: (yes)
```
-You can also do `jitsu deploy --release patch` to force `jitsu deploy` to
-increase the patch version number. For more fine-grained versioning control
+You can also do `jitsu deploy --release patch` to force `jitsu deploy` to
+increase the patch version number. For more fine-grained versioning control
see [jitsu config --release][release].
## Continuous integration
@@ -82,14 +82,14 @@ relevant [handbook section][handbook].
Deploy will normally include all files, excluding the *node_modules* directory.
The content that is deployed is dependant on `npm pack`. This command is
-executed by `jitsu deploy` and governs the snapshots we use for deployment.
+executed by `jitsu deploy` and governs the snapshots we use for deployment.
`npm pack` by default ignores files and folders starting with an dot, e.g.
-*.DS_Store*. In addition, it also takes *.gitignore* and *.npmignore* into
+*.DS_Store*. In addition, it also takes *.gitignore* and *.npmignore* into
account. More information about this subject can be found in the [FAQ][faq].
[release]: /jitsu/config/#release
[faq]: /a-quickstart/faq/#why-is-the-subdirectory-or-its-content-not-deployed-to-nodejitsu
[handbook]: /features/webhooks/
-[gettingstarted]: https://www.nodejitsu.com/getting-started-with-github/
+[gettingstarted]: https://www.nodejitsu.com/getting-started-with-github/
[package]: /appendix/package-json/
[meta:title]: <> (Deploying apps)
View
@@ -1,8 +1,8 @@
# Jitsu
Jitsu is a Command Line Tool (CLI) for managing and deploying Node.js
-applications. It's open-source and easy to use. We've designed jitsu to
-be suitable for command line beginners, but still be powerful and
+applications. It's open-source and easy to use. We've designed jitsu to
+be suitable for command line beginners, but still be powerful and
extensible enough for production usage. Jitsu day to day use:
* [Login](#login)
@@ -18,12 +18,12 @@ can signup after. `npm` is required for installing the `jitsu` package.
[sudo] npm install jitsu -g
```
-If you prefer using git repositories over the package you can also install
+If you prefer using git repositories over the package you can also install
`jitsu` by cloning the repository and linking with npm after. This would also
-allow you to contribute to jitsu more easily.
+allow you to contribute to jitsu more easily.
```bash
-git clone git@github.com:nodejitsu/jitsu.git
+git clone git@github.com:nodejitsu/jitsu.git
[sudo] npm link
```
@@ -36,15 +36,16 @@ line however, execute:
jitsu signup
```
-Choose your preferred username and provide a password. If your username is
+Choose your preferred username and provide a password. If your username is
already taken you will be provided with adequate feedback. Make sure you enter a
valid e-mail address.
## Login
Before accessing our API through jitsu a login is required. You will be prompted
to provide you username and password. Your password will be hidden, e.g. if you
-type you'll not see any characters. Don't worry it is working as intended.
+type you'll not see any characters. Don't worry it is working as intended. After
+your logged in every command you execute with `jitsu` is against your account.
```bash
jitsu login
@@ -78,8 +79,8 @@ jitsu install helloworld
```
If you receive an `EACCES` error the current directory is not writable for
-jitsu. If all goes well, you will be prompted to start the application, by
-default the server will be listening to *port 8080*. To check the results
+jitsu. If all goes well, you will be prompted to start the application, by
+default the server will be listening to *port 8080*. To check the results
visit *http://localhost:8080/*. If you get an `EADDRINUSE` error the *port 8080*
is already in use. Close the other application before starting the helloworld
demo.

0 comments on commit 5a28d8f

Please sign in to comment.