arangodb / docs-hugo

Source code of the ArangoDB online documentation
https://docs.arangodb.com
Apache License 2.0
5 stars 5 forks source link

DOC-659 | Windows and macOS #473

Closed nerpaula closed 8 months ago

nerpaula commented 8 months ago

Description

TODOs:

Upstream PRs

arangodb-docs-automation[bot] commented 8 months ago

Deploy Preview Available Via
https://deploy-preview-473--docs-hugo.netlify.app

Simran-B commented 8 months ago

Windows-specific startup options that get removed from arangod:

And for arangosh:

They won't show up in the scheduled workflow because they are not available at all in Linux builds. This also means they never appeared in the auto-generated startup option list. There was also no other mention in the docs it seems.

The --random.generator startup option of arangod had an already deprecated option for WinCrypt (5) which gets removed.

Simran-B commented 8 months ago

https://deploy-preview-473--docs-hugo.netlify.app/devel/get-started/on-premises-installation/ should be changed to not mention Windows / show examples with Windows paths and probably changed to explain the available options (bare metal Linux and Docker), and that you can use Docker Desktop to run ArangoDB under Windows and macOS.


--dump-options and the new startup option endpoints report operating systems under os which defaults to ["linux", "macos", "windows"]. Jan will make a change in his PR to not report Windows anymore. macOS to be removed later as well.

The program-options.md shortcode needs to be adjusted because there is a check whether the reported OS list has 3 elements, which will become 2 with the Windows removal PR. As macOS will also be removed, there is no point in building up and displaying the OS info at all but we need to keep the functionality for 3.10 and 3.11.

--> Pushed a commit for this (no more mentions of "Linux only" or "Linux and macOS only" in the startup option overview for 3.12)

Simran-B commented 8 months ago

The random options are apparently in the server and client tools, so the change to --random.generator should say server and client tools.

Simran-B commented 8 months ago

Removed error code:

- name: ERROR_OUT_OF_MEMORY_MMAP
  text: "out of memory in mmap"
  desc: "Will be raised when there is a memory shortage."
  code: 12