h2database / h2database/h2database

Create a versioned documentation

Open
#1,809 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
4.6k
Forks
1.3k
Avg merge
1d 2h
Merged PRs (30d)
9

Description

The current documentation only allows for checking SQL syntax supported by the latest H2 version.

For example, I'm interested in when OFFSET .. FETCH support was added. I can't see that in the documentation: http://h2database.com/html/commands.html#select as I cannot navigate to an older H2 version. I have to check the release notes.

Would be great to have versioned documentation.

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.

Research direction

Start with the current documentation at commands.html#select and compare it with the release notes, which are the existing source for when syntax was added. Define how older H2 versions should be selected and how the versioned documentation should expose support such as OFFSET .. FETCH; done means users can check SQL syntax for an older version without consulting release notes.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
databases, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.