orientechnologies / orientechnologies/orientdb-docs

Misleading documentation

Open
#278 0 comments 0 reactions 1 assignee View on GitHub

@kennethpjdyer is already working on this.

Since Apr 26, 2017.

Dominant language
CSS
Stars
59
Forks
165
PR merge metrics
No merged PRs in 30d

Description

From a user:

Here is something that I think is bad in the documentation. the syntax says

CREATE DATABASE REMOTE:192.168.1.1/trick root 
          E30DD873203AAA245952278B4306D94E423CF91D569881B7CAD7D0B6D1A20CE9 PLOCAL

so when we tried to do it, we kept getting error and thought we are doing something wrong but not connecting properly. but apparently PLOCAL needs to be lowercased.. same for drop database, the error says we cannot but that's because the syntax is uppercased in the documentation and needs to be lowercased..

also, we had some queries that were either missing ")" or misspelling of commands.

I think this might frustrate new users who are trying it for the first time. I think it would be good for the documentation guy to run the commands on the page just to make sure that they work.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.