Skip to content

[Docs] SQL Developer Guide #5865

@rmloveland

Description

@rmloveland

Background: https://airtable.com/tblD3oZPLJgGhCmch/viw1DKmbKhg2MIECH/rec3BeYWPmj5yce1x

Description: The docs section now includes a SQL Developer Guide that pulls out content on creating and updating data and other high-level topics with SQL development.

The reference section now only contains reference information.

Currently, the docs section is organized around SQL reference material. However, a lot of the material isn't really reference material. Instead, it is part of a SQL developer guide that could be lost as it is interleaved with reference material.

Team: Andrew Woods, Rafi Shamim, Richard Loveland


Right now we have a lot of reference material about SQL, database architecture, query & cluster performance tuning, and other important things. We also have some small example "apps".

In addition to the above, we would like to create a new 'Developer Guide' that makes it easier for people writing applications to get up and running with CockroachDB.

Sample topics should be task-oriented and make it easy to find the information you need to get your job done.

For example, topics could include something like this incomplete list (details TBD):

  • Connect to the database
  • Insert data
  • Query data
  • Update data
  • Error handling
  • Example apps
  • ... etc.

(In days of old this might have been called something like the "CockroachDB Application Developer's Manual".)

Estimated scope of work for this issue:

  • Determine the list of topics that should be in a high-quality, task-focused Developer Guide
  • Develop an outline
  • Do it!

See also:

Metadata

Metadata

Assignees

Labels

P-1High priority; must be done this release

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions