Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(docs) update MonsterPi procedure #226

Merged
merged 8 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,23 @@
"configdb",
"davidzwa",
"devblog",
"devblogs",
"devpath",
"Dumnersm",
"Dyrant",
"FDMM",
"fdmmonster",
"Gcode",
"gencert",
"Gijs",
"Gitbook",
"Groote",
"healthcheck",
"iconify",
"Imager",
"INITDB",
"Kevenaar",
"Kissling",
"klipper",
"mauricekevenaar",
"Mikro",
Expand All @@ -35,6 +40,7 @@
"SAFEMODE",
"shoutout",
"sidenav",
"svgrepo",
"tideline",
"Tobikiss",
"TYPEORM",
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

```bash
yarn start --no-open
```

This command starts a local development server without opening a browser window. You can open the website using <http://localhost:3000>

### Build

```bash
Expand Down
2 changes: 1 addition & 1 deletion blog/2024/11-03 Documentation site revamp/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ The main changes are:
- The [Our Team](/docs/community/ourteam) page has been moved to the Community section
- A new page with [external links](/docs/community/links) has been added.
- Blogs!
- The devlogs from Discord have been moved over here!
- The devblogs from Discord have been moved over here!
25 changes: 25 additions & 0 deletions blog/2025/01-02 MonsterPi Documentation/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: MonsterPi Documentation
authors:
- mkevenaar
tags: [devblog]
slug: /monsterpi-documentation
description: Rewritten the MonsterPi documentation
---

## 📖 Documentation changes

We have completely rewritten the FDM Monster [MonsterPi](/docs/installing/monsterpi) documentation.

<!-- truncate -->

The main changes are:

- The Raspberry Pi Imager documentation has completely rewritten.
- This includes a total of 13 screenshots.
- A table with suggested items has been added for your MonsterPi device.
- The Windows and Linux installations that have been deprecated for a while has been moved to the deprecated folder.
- Some sections have been reworded
- Documentation for upgrading MonsterPi images before 0.4.x has been removed. Upgrading to 0.4.x is advised.
- A [Chat on Discord](https://discord.gg/mwA8uP8CMc) link has been added to the homepage
- Soon the FDM Monster website will be redirected to the documentation.
Binary file removed docs/images/raspberrypi/raspberrypi-imager.png
Binary file not shown.
15 changes: 15 additions & 0 deletions docs/installing/deprecated/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Deprecated
description: Deprecated documentation
slug: /installing/deprecated
---

:::danger
Deprecated documentation. This documentation is there for your convenience. This documentation is provided as-is and will not be supported.
:::

```mdx-code-block
import DocCardList from '@theme/DocCardList';

<DocCardList />
```
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Linux Service
description: How to use a Linux service for your FDM-Monster environment (deprecated)
slug: /installing/linux_service
pagination_next: configuration/index
slug: /installing/deprecated/linux_service
pagination_prev: installing/deprecated/index
---

:::danger
Expand All @@ -15,7 +15,7 @@ The scripts on this page are available on GitHub in [installations/fdm-monster-n

![A running instance of FDM Monster 3D Printing Server with the Printing Grid opened.
Only one disabled printer is shown on the grid and it's disabled.
The rest of the grid is showing empty tiles.](../images/server-running.png)
The rest of the grid is showing empty tiles.](../../images/server-running.png)
*This is the FDM Monster web app after installation (visit [http://127.0.0.1:4000](http://127.0.0.1:4000))*

## Preparation of the Linux Service installation
Expand Down Expand Up @@ -57,7 +57,7 @@ Each configuration change requires you to run the update script:
npm i
```

Please read the [Environment configuration](../configuration/preconfiguration.mdx) section for adjusting the `.env` file.
Please read the [Environment configuration](../../configuration/preconfiguration.mdx) section for adjusting the `.env` file.

## Updating the server

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Windows Service
description: How to use a Windows service for your FDM-Monster environment (deprecated)
slug: /installing/windows_service
pagination_next: configuration/index
slug: /installing/deprecated/windows_service
pagination_prev: installing/deprecated/index
---
:::danger

Expand All @@ -20,7 +20,7 @@ in [installations/fdm-monster-node-windows](https://github.com/fdm-monster/fdm-m

![A running instance of FDM Monster 3D Printing Server with the Printing Grid opened.
Only one disabled printer is shown on the grid and it's disabled.
The rest of the grid is showing empty tiles.](../images/server-running.png)
The rest of the grid is showing empty tiles.](../../images/server-running.png)
*This is the FDM Monster web app after installation (visit [http://localhost:4000](http://localhost:4000))*

## Preparation for the Windows service installation
Expand Down Expand Up @@ -127,7 +127,7 @@ containing the description `FDM Monster` in Task Manager.
The service should have `Status: Running``. If this is not the case, something went wrong. Reach out to us
via [Discord](https://discord.gg/mwA8uP8CMc) for more help!

![Windows Task Manager showing the Services tab on which a service named fdmmonster.exe is showing status Running](../images/task-manager.png)
![Windows Task Manager showing the Services tab on which a service named fdmmonster.exe is showing status Running](../../images/task-manager.png)

If things are working, you can open FDM Monster with this URL: [http://localhost:4000](http://localhost:4000)
or [http://127.0.0.1:4000](http://127.0.0.1:4000).
Expand Down Expand Up @@ -170,5 +170,5 @@ Run the script as follows:
./uninstall-fdm-monster.ps1
```

Please continue to [Environment configuration](../configuration/preconfiguration.mdx) to change the environment
Please continue to [Environment configuration](../../configuration/preconfiguration.mdx) to change the environment
configuration of the FDM Monster server.
3 changes: 2 additions & 1 deletion docs/installing/docker_compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: Docker and Docker Compose
description: How to use Docker for your FDM-Monster environment
slug: /installing/docker_compose
pagination_next: configuration/index
pagination_prev: installing/index
pagination_next: software_usage/index
---

:::info
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/installing/images/rpi-imager-custom-os.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/installing/images/rpi-imager-done.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/installing/images/rpi-imager-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/installing/images/rpi-imager-next.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/installing/images/rpi-imager-sd-card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/installing/images/rpi-imager-verifying.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/installing/images/rpi-imager-writing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading