Skip to content

Commit

Permalink
docs: more improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
atinux committed Aug 15, 2024
1 parent 521662a commit efe912f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 14 deletions.
4 changes: 3 additions & 1 deletion docs/content/1.docs/1.getting-started/4.remote-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Your project [must be deployed](/docs/getting-started/deploy) in order to use th

Once your project is deployed, you can use the remote storage in your local project.

:nuxt-img{src="/images/landing/nuxthub-schema.png" alt="NuxtHub Schema" width="766" height="498" data-zoom-src="/images/landing/nuxthub-schema.png"}

Start your Nuxt project with:

```bash [Terminal]
Expand All @@ -25,7 +27,7 @@ npx nuxt dev --remote

The development project will now use the remote storage from your deployed project and these logs should happen in your terminal:

```bash
```bash [Terminal]
ℹ Using production environment
ℹ Using remote storage from https://my-project.nuxt.dev
ℹ Remote storage available: database, kv, blob
Expand Down
14 changes: 5 additions & 9 deletions docs/content/1.docs/1.getting-started/5.server-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,32 @@ When you have a successful deployment, you can access to the logs of the deploym

Logs are available under the `Server > Logs` section of your project page. You can also access to the logs of each successful deployment in the `Deployments` section.

::a{href="https://admin.hub.nuxt.com"}
:nuxt-img{src="/images/landing/nuxthub-admin-server-logs.png" alt="NuxtHub Admin Server Logs" width="915" height="515" data-zoom-src="/images/landing/nuxthub-admin-server-logs.png"}
::
:nuxt-img{src="/images/landing/nuxthub-admin-server-logs.png" alt="NuxtHub Admin Server Logs" width="915" height="515" data-zoom-src="/images/landing/nuxthub-admin-server-logs.png" class="rounded"}

## NuxtHub CLI

Using the [NuxtHub CLI](https://github.com/nuxt-hub/cli), you can access to the logs of both `production` and `preview` deployments.

By default, the CLI will detect based on the current branch the canonical deployment of your project and stream the logs of that deployment in the CLI.

```bash
```bash [Terminal]
nuxthub logs
```

::a{href="https://github.com/nuxt-hub/cli"}
:nuxt-img{src="/images/landing/nuxthub-cli-server-logs.png" alt="NuxtHub CLI Server Logs" width="915" height="515" data-zoom-src="/images/landing/nuxthub-cli-server-logs.png"}
::
:nuxt-img{src="/images/landing/nuxthub-cli-server-logs.png" alt="NuxtHub CLI Server Logs" width="915" height="515" data-zoom-src="/images/landing/nuxthub-cli-server-logs.png" class="rounded"}

### Production environment

To access the logs of the production environment, you can use the `--production` flag.

```bash
```bash [Terminal]
nuxthub logs --production
```

### Preview environment

In preview environment, NuxtHub will stream the logs of the latest successful deployment in the CLI.

```bash
```bash [Terminal]
nuxthub logs --preview
```
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ You can host your drawing application on a **free Cloudflare account** and **fre

All you have to do is to run one single command:

```bash
```bash [Terminal]
npx nuxthub deploy
```

Expand All @@ -431,11 +431,10 @@ If you prefer, you can also deploy this project using the NuxtHub Admin by click

Once your project is deployed, you can use [NuxtHub Remote Storage](/docs/getting-started/remote-storage) to connect to your preview or production Cloudflare R2 bucket in development using the `--remote` flag:

```bash
```bash [Terminal]
npx nuxt dev --remote
```


## Manage Drawings

Some users may draw inappropriate drawings that we may want to remove. For this, NuxtHub provides a Blob panel in both the Nuxt DevTools and the NuxtHub Admin.
Expand All @@ -454,7 +453,7 @@ You can manage all the drawings using the Blob panel in the NuxtHub Admin.

Once deployed, open the admin panel of your application with:

```bash
```bash [Terminal]
npx nuxthub manage
```

Expand Down

0 comments on commit efe912f

Please sign in to comment.