docs: enhance faq

[niko-at-chalupa]

Fix a grammatical error and acknowledge the viability with Endstone and ARM architectures.

I've added a tip in the FAQ that emphasizes how Docker emulation can make Endstone work on ARM with good performance. As the popularity of ARM for servers rises, I think making Endstone sound more viable for ARM in places such as the FAQ is important for the project's growth.

[Aevarkan]

Would using a footnote perhaps be better formatting wise? More details in the review.

[Aevarkan]

I imagine this could leave someone reading this who wanted to run a server on arm architecture quite stranded.

This PR currently tells them that Docker emulation allows Endstone to run on arm, but it doesn't show how to run it on arm architecture.

I believe it'd be a good idea to also include a tutorial, or a link to one, in addition to confirming that Endstone can run on arm architecture via Docker emulation.

[niko-at-chalupa]

I imagine this could leave someone reading this who wanted to run a server on arm architecture quite stranded.

This PR currently tells them that Docker emulation allows Endstone to run on arm, but it doesn't show how to run it on arm architecture.

I believe it'd be a good idea to also include a tutorial, or a link to one, in addition to confirming that Endstone can run on arm architecture via Docker emulation.

That sounds great! I initially assumed that "people will just look it up anyways", but it makes sense how people who don't know about Docker and such won't be able to set it up. Do you think it's worth actually making a page for setting this up, or is a link to something "good enough"?

[Aevarkan]

I imagine this could leave someone reading this who wanted to run a server on arm architecture quite stranded.
This PR currently tells them that Docker emulation allows Endstone to run on arm, but it doesn't show how to run it on arm architecture.
I believe it'd be a good idea to also include a tutorial, or a link to one, in addition to confirming that Endstone can run on arm architecture via Docker emulation.

That sounds great! I initially assumed that "people will just look it up anyways", but it makes sense how people who don't know about Docker and such won't be able to set it up. Do you think it's worth actually making a page for setting this up, or is a link to something "good enough"?

Depends on how much effort you want to put in 😆

Personally, I'd go for a dedicated page in the Tutorials section. Doing a tutorial in-house makes the user experience smoother. In exchange, it's more work for you.

Note that, to add a new page, you'll need to also edit the mkdocs.yml file:

endstone/mkdocs.yml

Lines 195 to 202 in 7a07a52

	- Tutorials:
	- Create your first plugin: tutorials/create-your-first-plugin.md
	- Install your plugin: tutorials/install-your-plugin.md
	- Use color codes: tutorials/use-color-codes.md
	- Register commands: tutorials/register-commands.md
	- Register event listeners: tutorials/register-event-listeners.md
	- Schedule tasks: tutorials/schedule-tasks.md
	- Publish your plugin: tutorials/publish-your-plugin.md

Of course, it's not me that has the final say on this.

[niko-at-chalupa]

I imagine this could leave someone reading this who wanted to run a server on arm architecture quite stranded.
This PR currently tells them that Docker emulation allows Endstone to run on arm, but it doesn't show how to run it on arm architecture.
I believe it'd be a good idea to also include a tutorial, or a link to one, in addition to confirming that Endstone can run on arm architecture via Docker emulation.

That sounds great! I initially assumed that "people will just look it up anyways", but it makes sense how people who don't know about Docker and such won't be able to set it up. Do you think it's worth actually making a page for setting this up, or is a link to something "good enough"?

Depends on how much effort you want to put in 😆

Personally, I'd go for a dedicated page in the Tutorials section. Doing a tutorial in-house makes the user experience smoother. In exchange, it's more work for you.

Note that, to add a new page, you'll need to also edit the mkdocs.yml file:

endstone/mkdocs.yml

Lines 195 to 202 in 7a07a52

	- Tutorials:
	- Create your first plugin: tutorials/create-your-first-plugin.md
	- Install your plugin: tutorials/install-your-plugin.md
	- Use color codes: tutorials/use-color-codes.md
	- Register commands: tutorials/register-commands.md
	- Register event listeners: tutorials/register-event-listeners.md
	- Schedule tasks: tutorials/schedule-tasks.md
	- Publish your plugin: tutorials/publish-your-plugin.md

Of course, it's not me that has the final say on this.

I'll get working on a draft for the tutorial. It'll include most of the essential parts. Thank you!

[Aevarkan]

If you want a bit of inspiration, here's a tutorial I once made. One of my good ones! The tone I use is quite different from most.

There's also the existing Endstone tutorials, which I'm sure you've already had a look at.

[niko-at-chalupa]

I've made my tutorial in installation.md near the end, adding onto the existing Docker setup section (I think it fits best there).

Initially, it was going to be a full beginner's guide to Docker, but I decided against that and went with that instead, as it's better to have it like a "quick start" guide rather than a full one as it's way more practical.

[Aevarkan]

Good idea!

I didn't see how well that section already fit. I've made a few suggestions in the review. 🙂

[Aevarkan]

Two things here:

1

I recommend explaining these Docker flags outside of the code block:

• --platform linux/amd64
• -p 19132:19132
• -d
• --name endstone-server

I got confused myself, I thought -d --name endstone-server was a single flag before I looked it up while writing this.

2

The existing documentation has the docker run command in the Getting Started > Start your server page instead of the Getting Started > Installation page.

endstone/docs/getting-started/start-your-server.md

Lines 14 to 27 in 7a07a52

	Alternatively, if you're running Endstone from within Docker, use:
	=== ":fontawesome-brands-linux: Linux / :fontawesome-brands-windows: Powershell"
	```
	docker run --rm -it -v ${PWD}:/home/endstone -p 19132:19132/udp endstone/endstone
	```
	=== ":fontawesome-brands-windows: Command Prompt"
	```
	docker run --rm -it -v "%cd%":/home/endstone -p 19132:19132/udp endstone/endstone
	```

[niko-at-chalupa]

1

How about something like this:

docker run \
--platform linux/amd64 \ # Emulate Linux + amd64 architecture
-p 19132:19132 \ # Bind port 19132 on the host to the same port in the container
-it \ # Makes the output like a real terminal, and keeps stdin so you can type commands in
-v ${PWD}:/home/endstone \ # Mounts the disposable container a volume, so data like worlds will persist after the container is deleted.
--name endstone-server \
endstone/endstone

(I've also made the command more consistent with the one Endstone's run command uses)

I think that's better, and we can comment on each flag individually (we could also make the other examples have such comments since Docker flags can be confusing).

2

The existing documentation has the docker run command in the Getting Started > Start your server page instead of the Getting Started > Installation page.

It makes sense to put it in there, I should've checked before putting it in installation. I'll move the "running" the server part into there.

[Aevarkan]

Sounds good!

It's up to you whether or not you could even add those comments for the other examples. Personally, I like that idea.

[Aevarkan]

Looks mostly good - just some styling that stands out to me.

It might seem a bit strange to mention macOS, as Endstone doesn't officially support the platform.

Personally, I believe it's a good addition though. You'll have to get feedback from others regarding that.

[niko-at-chalupa]

Looks mostly good - just some styling that stands out to me.

It might seem a bit strange to mention macOS, as Endstone doesn't officially support the platform.

Personally, I believe it's a good addition though. You'll have to get feedback from others regarding that.

Emulation makes Endstone work on macOS while also making it work on ARM, and a big portion of the ARM user base is on Apple silicon (which runs macOS by default). I've also confirmed that it works on macOS through emulation too, so I think it's a valid addition

[wu-vincent]

Hi both! Thank you for the contribution and the discussion above. These changes look all good to me!

[Aevarkan]

I can't believe this amount of praise was enough to make me feel really happy 😁