Merge pull request #169 from vgjm/dev

feat: improve quick-start, add introduction to bookinfo in deploy-demo

Author: vgjm

docs/guides/deploy/deploy-demo.md

@@ -2,11 +2,11 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
 
 # Deploy Demo Application
 
-Nocalhost IDE plugin has built-in demo application, you can quickly install it through the following steps:
+Nocalhost IDE plugin has a built-in demo application called bookinfo. You can quickly install it through the following steps:
 
 1. Select any namespace from the cluster tree
 2. Click on the <img src={useBaseUrl('/img/icons/install-app-icon.jpg')} width="20" /> icon to deploy application
-3. Select `Install Quick Demo` to install the demo application
+3. Select `Deploy Demo` to install the demo application
 
 <figure className="img-frame">
   <img className="gif-img" src={useBaseUrl('/img/opt/deploy-demo.gif')} />
@@ -19,3 +19,29 @@ Quick demo application comes with port-forward configured. After demo has succes
 
 :::
 
+## Introduction to the bookinfo application
+
+Bookinfo is a typical microservice architecture application, which derives from Istio samples(https://github.com/istio/istio/tree/master/samples/bookinfo). However, we commit some changes to demonstrate nocalhost better. Here are some main changes we have made:
+
+- Simplifying different version of reviews service to one version. Nocalhost does not target on how to manage service traffic or canary deployment.
+- Splitting source codes from mono-repo into five independent repositories. In fact, diffrent microservices are developed by diffrent teams with different access rules.
+- Switching the framework of reviews service to spring-boot. Everyone loves spring-boot.
+- Configuring GitHub Action for every microservice to automatically build Docker images.
+- Adding a .nocalhost directory to support development with nocalhost. 
+
+This demo application consists of the following 5 services:
+
+- productpage(Request Entrance): https://github.com/nocalhost/bookinfo-productpage
+- reviews: https://github.com/nocalhost/bookinfo-reviews
+- details: https://github.com/nocalhost/bookinfo-details
+- ratings: https://github.com/nocalhost/bookinfo-ratings
+- authors: https://github.com/nocalhost/bookinfo-authors
+
+Every service has its own program language and runtime environment. All of them have been configured to use docker as the container runtime, you can find Dockerfile in their corresponding repositories.
+
+The microservices' structure of bookinfo is shown by the following image: 
+
+<figure className="img-frame">
+  <img className="gif-img" src={useBaseUrl('/img/intro/structure-of-bookinfo.png')} />
+  <figcaption>Microservices' structure of bookinfo</figcaption>
+</figure>

docs/guides/hot-reload.md

@@ -99,4 +99,6 @@ containers:
 
 ```
 
+## What's Next?
 
+Now you have understood what DevMode is and how it works. Nocalhost supports a lot of configurations that control the actions when Nocalhost enter DevMode. If you are interested in Nocalhost configurations, you can check [CONFIGURATION](https://nocalhost.dev/docs/config/config-en).

docs/quick-start.md

@@ -31,7 +31,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
 
 :::tip JetBrains Plugin
 
-Nocalhost does fully supports JetBrains, please refer to [Install JetBrains Plugin](./installation##install-jetbrains-plugin).
+Nocalhost does fully support JetBrains, please refer to [Install JetBrains Plugin](./installation##install-jetbrains-plugin).
 
 :::
 
@@ -100,9 +100,9 @@ We are using the bookinfo application as an example here. You can use your own a
 
 Make sure you have successfully deployed workloads within your Kubernetes Cluster, then:
 
-1. Expand the workloads tree, find the workload you want to develop
+1. Expand the workloads tree, find the productpage workload to begin our development
 2. Click <img className="svg-icon" src={useBaseUrl('/img/icons/dev_start.svg')} width="18" /> to start the `Development Mode (DevMode)`
-3. Specify the source code local directory or you can clone from existing Git repository. 
+3. Clone source code from a Git repository (or you can associate with a local derectory). 
 4. Nocalhost will open a new VS Code window, and start the `DevMode` automatically.
 
 <figure className="img-frame">
@@ -126,7 +126,7 @@ When entering DevMode, the application main process will not automatically start
 
 :::
 
-**2.** View the running result on [http://127.0.0.1:39080](http://127.0.0.1:39080) in your web browser
+**2.** View the running result on [http://127.0.0.1:39080/productpage](http://127.0.0.1:39080/productpage) in your web browser
 
 <figure className="img-frame">
   <img className="gif-img" src={useBaseUrl('/img/opt/main-process.gif')} />
@@ -141,7 +141,7 @@ In our `bookinfo` demo, we've already set the port-forward to 39080:9080, which
 
 ### Change the code
 
-**1.** Modify code in  `productpage.py` and see change in web browser. **Do not** forget to save your change.
+**1.** Modify code in  `productpage.py` and see change in web browser. Find the `getProducts` function in line 379 and change the `'title'` of the return value from `'The Comedy of Errors'` to `'Hello Nocalhost'`. **Do not** forget to save your change.
 
 **2.** Refresh the web browser and see the code change
 
@@ -154,6 +154,10 @@ In our `bookinfo` demo, we've already set the port-forward to 39080:9080, which
 
 ## What's Next?
 
+Now you are ready to develop with Nocalhost. But if you still want more details about Nocalhost, you can consult [USER GUIDES](https://nocalhost.dev/docs/guides/manage-cluster), or if you are a team leader, then you can try [Nocalhost Server](https://nocalhost.dev/docs/server/server-overview) and understand how Nocalhost can improve your team's efficiency.
+
+You can also:
+
 - Refer to Nocalhost's [Introduction](./introduction)
 - Visit our [Github Repo](https://github.com/nocalhost/nocalhost)
 - Join our [Slack](https://nocalhost.slack.com/) or scan the code to join our WeChat Group

docs/server/nh-dep.md

@@ -6,3 +6,6 @@ Service dependencies can be defined through `services[*].dependLabelSelector` in
 
 **`Nocalhost Dep`** will inject an `initContainer` into the container when deploying an application. The `initContainer` will ensure that the services it depends on run successfully and then create the related container.
 
+## What's Next?
+
+You have finished Nocalhost Server section. You can use Nocalhost to accelerate your team's development process. But we recommend you to read the [Best Prictices](https://nocalhost.dev/docs/practice/cloud/k8s-compatible) section before using Nocalhost. 

docs/summary.md

@@ -0,0 +1,28 @@
+## Try Nocalhost
+- [What's Nocalhost](https://nocalhost.dev/docs/introduction)
+- [Install Nocalhost](https://nocalhost.dev/docs/installation)
+- [Quick Start](https://nocalhost.dev/docs/quick-start)
+
+## Develop with Nocalhost
+- [Manage cluster](https://nocalhost.dev/docs/guides/manage-cluster)
+- [Deploy demo application](https://nocalhost.dev/docs/guides/deploy/deploy-demo)
+- [Enter DevMode(Replace)](https://nocalhost.dev/docs/guides/develop-service-replace-en)
+- [Remote debug](https://nocalhost.dev/docs/guides/debug/vscode-debug)
+- [Connect remote terminal](https://nocalhost.dev/docs/guides/debug/access-terminal)
+- [View logs](https://nocalhost.dev/docs/guides/debug/log-viewer)
+
+## Nocalhost Configuration
+- [Introduction of Nocalhost configuration](https://nocalhost.dev/docs/config/config-overview-en)
+- [How to configure Nocalhost](https://nocalhost.dev/docs/config/configure-en)
+- [Dev configuration of Nocalhost](https://nocalhost.dev/docs/config/config-spec-en)
+- [Deployment configuration of Nocalhost](https://nocalhost.dev/docs/config/config-deployment-en)
+
+## Nocalhost Server
+- [Introduction of Nocalhost Server](https://nocalhost.dev/docs/server/server-overview)
+- [Use Nocalhost Server](https://nocalhost.dev/docs/server/deploy-server)
+- [Upgrade repository](https://nocalhost.dev/docs/server/upgrade)
+- [Manage user](https://nocalhost.dev/docs/server/manage-user)
+- [Manage cluster](https://nocalhost.dev/docs/server/manage-cluster)
+- [Isolated devspace](https://nocalhost.dev/docs/server/manage-devspace-iso)
+- [Mesh devspace](https://nocalhost.dev/docs/server/manage-devspace-mesh)
+- [Use Nocalhost Server in Kubesphere](https://nocalhost.dev/docs/server/deploy-in-kubesphere-en)