orientechnologies / orientechnologies/orientdb-docs

Console command docs and SQL commands cause confusion

Open
#178 2 comments 0 reactions 1 assignee View on GitHub

@santo-it is already working on this.

Since Feb 23, 2017.

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

Description

There are two related issues with the console documentation:

Incomplete list of commands

The SQL commands listed in the table do not match the commands listed on the left navigation bar under Console
e.g. The command table doesn't include "Create Property" but it does appear in the navigation.

Console command pages should point to SQL command pages only
The console command pages such as:
http://orientdb.com/docs/last/Console-Command-Create-Property.html

And the SQL command pages such as:
http://orientdb.com/docs/last/SQL-Create-Property.html

are causing confusion because they contain overlapping content. The console page is usually a subset of the sql page but for no apparent reason. I'd suggest combining the two sets of pages otherwise console users tend to miss the full SQL syntax.

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.