apache / doris

Apache Doris is an easy-to-use, high performance and unified analytics database.
https://doris.apache.org
Apache License 2.0
12.55k stars 3.24k forks source link

[Doris-Future](docs) Isolated documents detection and fix #31383

Closed zclllyybb closed 7 months ago

zclllyybb commented 8 months ago

Search before asking

Description

Nowadays our document has many isolated pages like https://doris.apache.org/zh-CN/docs/dev/sql-manual/sql-reference/Data-Definition-Statements/Create/CREATE-JOB (isolated means they are not included by sidebar so we can't jump to them from sidebar. but could by searching). We need to link them to proper category.

Solution

the documents' organization is all in docs/sidebars.json. you can write a script easily (maybe with helping of gpt) to travel docs/ directory and find all *.md files. then compare them with sidebars.json to figure out which ones are not included properly. then fix the sidebars.json. put the missing ones into right category.

Are you willing to submit PR?

Code of Conduct

Paynezheng commented 8 months ago

I ran the shell command: tree -f -P *.md | grep .md | awk -F'\\./' '{print $2}' There are 2 question:

  1. some zh-CN docs and en documents have different file names.
  2. The number of documents varies.

1708923441323

How to deal with this files?

CSTGluigi commented 8 months ago

Is it right for me to push like #31409 ?

CSTGluigi commented 8 months ago

I ran the shell command: tree -f -P *.md | grep .md | awk -F'\\./' '{print $2}' There are 2 question:

  1. some zh-CN docs and en documents have different file names.
  2. The number of documents varies.

1708923441323

How to deal with this files?

well ,I forgot to request assignment.Sry

zclllyybb commented 8 months ago

I ran the shell command: tree -f -P *.md | grep .md | awk -F'\\./' '{print $2}' There are 2 question:

  1. some zh-CN docs and en documents have different file names.
  2. The number of documents varies.

1708923441323

How to deal with this files?

If you find some clearly wrong spelling, feel free to fix them~ but sorry for this issue I'd rather assign it to @CSTGluigi since he already made a Pull Request WIP. If you have found some more typo, it's still good for your first issue