DOC-385 | Add overview of Tools to Getting Started #1316
Conversation
3.10/quick-start-guide.md Outdated
| - [ArangoDB Server](programs-arangod.html) is the core component of ArangoDB that | ||
| stores data and handles requets. You can communicate with the server through | ||
| the web interface, command-line interface, drivers, and REST API. |
There was a problem hiding this comment.
I think it's important to mention the name of the executable (arangod) and clarify the difference between an ArangoDB server as in an instance of the database system (which can be comprised of multiple arangod processes), the server binary, and a server node. For clusters, you shouldn't communicate with any server node but only Coordinators - not something that necessarily needs to be mentioned here, but perhaps there is a wording that leaves this room for interpretation.
There was a problem hiding this comment.
We have a dedicated page for "How to interact with ArangoDB" and this content seems like it would fit there. For the quick start guide, I would expect something shorter, for example, leaving out arangobench, and not focusing on the different executables/tools, but rather creating groups by topic. What I mean is that it should look at the tools more from a user perspective and be worded accordingly, like "get data into and out of ArangoDB" as a topic, covering arangoimport + arangoexport, but also mentioning other options like the API and the JSON upload/download option in the web interface (which is pretty limited but still). Similarly, arangodump, arangorestore, and arangobackup can be grouped together under a topic for backing up and restoring data/the system.
Co-authored-by: Simran <Simran-B@users.noreply.github.com>
There was a problem hiding this comment.
We should change all headlines to sentence case
| deployment modes, such as a single server instance, Active Failover, and cluster | ||
| (including Datacenter-to-Datacenter Replication). | ||
| | ||
| ## How to Get Data In and Out of ArangoDB |
| available in the Enterprise Edition. | ||
| | ||
| <!-- | ||
| ## How to Import Data |
There was a problem hiding this comment.
This is covered above.
I can't recall what I had in mind for "How to Operate ArangoDB" but I think it was in the direction of setting up and deploying ArangoDB, which is also covered above. There might be other aspects/tools we could cover, also as an opportunity to link to the Operations section of the docs, but maybe this is too much for this getting started content, and a headline "How to Operate ArangoDB" might simply be too broad.
| more about: | ||
| - Ways you can use and communicate with ArangoDB servers | ||
| - How to set up and deploy an ArangoDB instance | ||
| - Get data in and out of ArangoDB |
Co-authored-by: Simran <Simran-B@users.noreply.github.com>
2 participants
preview https://deploy-preview-1316--zealous-morse-14392b.netlify.app/docs/3.10/quick-start-guide.html