Skip to content

Commit

Permalink
Remove npm installation method temporarily (#209)
Browse files Browse the repository at this point in the history
* Remove npm installation method temporarily

* Remove npm installation method temporarily

* Remove npm installation method temporarily
  • Loading branch information
marcauberer committed Nov 4, 2021
1 parent b63f9c1 commit bda6f87
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 10 deletions.
6 changes: 0 additions & 6 deletions docs/docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ Compose Generator offers several different methods to start with. Choose the one
??? summary "Use it as Docker Container without installing"
Please refer to the guide on how to <a href="../install/docker" target="_blank">use Compose Generator with Docker</a>.

??? summary "Install it on your development machine via NPM"
If you have already installed NPM on your development machine, you can <a href="../install/npm" target="_blank">install Compose Generator via NPM</a>. The only thing NPM does, is to unpack the binary for your platform and architecture to the binaries directory of your system. Compose Generator will post-install predefined service templates and other essential files.

??? summary "Docker is not installed yet"
No problem. Some commands of Compose Generator can even by used without having Docker installed, although it is recommended to have Docker installed.

Expand All @@ -27,9 +24,6 @@ Compose Generator offers several different methods to start with. Choose the one
??? summary "Install it on your development machine"
If you use Windows on your development machine, please refer to the guide on how to <a href="../install/windows" target="_blank">install Compose Generator on Windows</a> and if you work with Linux, you can visit the guide on how to <a href="../install/linux" target="_blank">install Compose Generator on Linux</a>.

??? summary "Install it on your development machine via NPM"
If you have already installed NPM on your development machine, you can <a href="../install/npm" target="_blank">install Compose Generator via NPM</a>. The only thing NPM does, is to unpack the binary for your platform and architecture to the binaries directory of your system. Compose Generator will post-install predefined service templates and other essential files.

??? summary "I want to use it in production"
Compose Generator can also be used to generate production ready Docker Compose configurations. To use it in a production environment we have two options: One-time use or more frequent usage.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/usage/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Install command
As Compose Generator acts as a helper for your Docker environment, it can also be used to install Docker and Docker Compose on your host machine with a single command. This helps to make your start much more seamless. With the lastest version of Docker, the Docker Compose cli is already bundled into the Docker installation and is used by Compose Generator by default.

!!! warning
The install command does not work in combination with the dockerized version of Compose Generator. If you want to use the install command, please install Compose Generator on your host system. Please see the guides for [Linux](../../install/linux), [Windows](../../install/windows) or [NPM](../../install/npm) to do so.
The install command does not work in combination with the dockerized version of Compose Generator. If you want to use the install command, please install Compose Generator on your host system. Please see the guides for [Linux](../../install/linux), [Windows](../../install/windows) <!--or [NPM](../../install/npm) -->to do so.

## Usage
=== "Long form"
Expand Down
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ nav:
- install/linux.md
- install/windows.md
- install/docker.md
- install/npm.md
#- install/npm.md
- install/source.md
- quick-start.md
- Usage:
Expand Down
4 changes: 2 additions & 2 deletions media/readme-dockerhub.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@
Please visit the documentation on [compose-generator.com](https://www.compose-generator.com).

## Usage
You can use the Compose Generator CLI by directly installing it on your Docker host system, install it via npm or by generating your compose file with the Compose Generator Docker container on the fly.
You can use the Compose Generator CLI by directly installing it on your Docker host system<!--, install it via npm--> or by generating your compose file with the Compose Generator Docker container on the fly.

### Install Compose Generator CLI
For installation instructions for NPM, Linux, Windows, etc., please visit the [installation guide](https://www.compose-generator.com/install/linux).
For installation instructions for <!--NPM, -->Linux, Windows, etc., please visit the [installation guide](https://www.compose-generator.com/install/linux).

## QuickStart with Docker
**For Linux:**
Expand Down

0 comments on commit bda6f87

Please sign in to comment.