pingcap / pingcap/docs

Have our own reference pages instead of links.

Open
#15,338 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Change Request

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.
    In the functions-and-operators directory, there are many pages that simply uses a link to dev.mysql.com/doc/refman/... instead of explaining the function/operator in our own documentation. This also causes a dependency on an external resource.

  2. Describe your suggestion or addition.
    Create content describing the various functions and operators in TiDB, instead of simply linking to the mysql reference manual.

  3. Provide some reference materials (such as documents and websites) if you could.

$  git grep 'dev.mysql.com.*refman' | cut -d: -f1 | uniq -c | sort -n -r
  75 functions-and-operators/operators.md
  62 functions-and-operators/date-and-time-functions.md
  59 functions-and-operators/string-functions.md
  38 functions-and-operators/numeric-functions-and-operators.md
  35 functions-and-operators/json-functions.md
  19 functions-and-operators/miscellaneous-functions.md
  13 functions-and-operators/information-functions.md
  12 functions-and-operators/window-functions.md
  12 functions-and-operators/encryption-and-compression-functions.md
  12 functions-and-operators/aggregate-group-by-functions.md
  11 functions-and-operators/expressions-pushed-down.md
   8 functions-and-operators/bit-functions-and-operators.md

Contributor guide

Open the contributing guide

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 by running the listed git grep command to inspect external MySQL reference links in the functions-and-operators directory. Read the affected pages, including operators.md, date-and-time-functions.md, string-functions.md, and the other listed function pages, to determine the scope. Done means the relevant TiDB function and operator content is documented locally instead of relying on those links.

Written by the indexing model from the issue text.

Assessment

Tech stack
mysql, sql
Domain
databases, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.