BREAKING CHANGE: Change default serve port to 3000 and add ability to override

[reakaleek]

Closes #229

Changes

Changing default port to 3000 as it is a common port for local web development.

In the world of web development, localhost:3000 is a popular shorthand for localhost port 3000, the default port used by many web servers. It is often used to talk about development environments and is often the first port that web apps use to run.

Read more here: https://locall.host/3000/

Source: https://locall.host/3000/

However, this change also gives the ability to override the port if necessary.

% dotnet run -- serve --help                
Usage: serve [options...] [-h|--help] [--version]

Continuously serve a documentation folder at http://localhost:3000.
         File systems changes will be reflected without having to restart the server.

Options:
  -p|--path <string?>    Path to serve the documentation.
         Defaults to the`{pwd}/docs` folder (Default: null)
  --port <int>           Port to serve the documentation. (Default: 3000)

[reakaleek]

I understand that changing the default port can introduce some disruption.

But it's a very common port for local web development. Hence, I still wanted to suggest it.

Another major reason is https://stackoverflow.com/questions/69818376/localhost5000-unavailable-in-macos-v12-monterey/69829313#69829313

TL;DR some macOS service named AirPlay somehow utilizes the port 5000. And I actually encountered this problem myself. This could cause many errors for all macOS users in the future.

[reakaleek]

Also, I'm afraid this affects the docker image. I couldn't find how it serves on port 8080

[Mpdreamz]

Just checking one will suffice 😸 both will be set (don't ask my why!).

[reakaleek]

Okay 😅

c9b04bb

[reakaleek]

I'm starting to wonder.

IIUC, the main reason for the differing ports for the native binary and the docker image are dotnet defaults.

Would it be a better UX if both use the same port?

[Mpdreamz]

https://learn.microsoft.com/en-us/dotnet/core/compatibility/containers/8.0/aspnet-port has some background as to why its 8080.

In .net the default changes based on environments: https://learn.microsoft.com/en-us/aspnet/core/fundamentals/environments?view=aspnetcore-9.0

Which is not something we leverage. Docker is a prod environments hence the different port as the rest of the run environments which are dev by default..

It makes sense to normalize this to one non privileged port and forego the docker env check to keep it simple.

[reakaleek]

Do I understand correctly? We skip the environment check and always do UseUrls?

[Mpdreamz]

yes thats the less long winded conclusion 😸

We'll have to update https://github.com/elastic/docs-builder-example or maybe we should archive that repository now that we have the migration repositories.

[reakaleek]

281e30e