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-624 | Add ArangoML self-managed content #419

Closed nerpaula closed 7 months ago

nerpaula commented 8 months ago

Description

Added ArangoML on-prem content.

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

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

cw00dw0rd commented 8 months ago

@nerpaula We will try and consolidate the naming related to ArangoGraphML as right now we have about 6 different names for it depending on where you look across ArangoDB. Going forward, we would like to refer to it as ArangoGraphML and then if needed ArangoGraphML self-managed.

I think this can simplify the above-discussed issue of having two separate pages that have essentially the same information. My proposed layout change would have the existing GraphML page (changed to ArangoGraphML) and then a deploy page that has the current ArangoGraphML vs GraphML self-managed blurb, and then we can have a getting started section that has the existing walkthrough information, tutorials, etc.

Additionally, starting with the trial, we will no longer have ArangoGraph Notebooks that exist without ML. You will only be able to create a notebook server with ML services enabled. So, we could move the ArangoGraph notebook section into the ArangoGraphML > Getting Started section. The proposed change would look something like this:

Additionally, based on some above conversation, I would agree that it might make sense to have a specific page just for the specifications, as that is a major part of the services and might clutter the rest of the content.

WDYT?

nerpaula commented 8 months ago

@cw00dw0rd the proposed layout change sounds good! Let's move forward with this. However, I would leave out the Notebooks page for now and make the required changes in another PR once the change is ready to go in production (there's a separate ticket for this).

nerpaula commented 8 months ago

@cw00dw0rd @geenen124 @aMahanna the content is now reorganized, see https://deploy-preview-419--docs-hugo.netlify.app/devel/data-science/arangographml/ and sub-pages.

What changed:

As a result, we can have something along:

Happy to rename any of the pages or sections.