pingcap / pingcap/docs

Title of PDF is incorrect

Open
#15,983 2 comments 0 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

Error Report

  1. What is the URL/path of the document related to this issue?

https://download.pingcap.org/tidb-stable-en-manual.pdf

image

$ pdfinfo tidb-stable-en-manual.pdf 
Title:           TiDB Introduction                                          <--------------------------------------
Creator:         LaTeX with hyperref package
Producer:        XeTeX 0.99992
CreationDate:    Fri Dec 29 13:06:16 2023 CET
Custom Metadata: no
Metadata Stream: no
Tagged:          no
UserProperties:  no
Suspects:        no
Form:            none
JavaScript:      no
Pages:           5926
Encrypted:       no
Page size:       612 x 792 pts (letter)
Page rot:        0
File size:       111419027 bytes
Optimized:       no
PDF version:     1.5

The title is "TiDB Introduction", which it should be something like "TiDB User Manual".

  1. How would you like to improve it?

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 inspecting the PDF at https://download.pingcap.org/tidb-stable-en-manual.pdf and the documentation build metadata that produces its title. Confirm where the "TiDB Introduction" title is set, change it to a manual title such as "TiDB User Manual", and verify the generated PDF metadata with pdfinfo.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.