Skip to content

[KYUUBI #7434][DOC] Reformat contributing docs from RST to Markdown - #7717

Closed
dnskr wants to merge 1 commit into
apache:masterfrom
dnskr:rst-to-md-contributing-pages
Closed

[KYUUBI #7434][DOC] Reformat contributing docs from RST to Markdown#7717
dnskr wants to merge 1 commit into
apache:masterfrom
dnskr:rst-to-md-contributing-pages

Conversation

@dnskr

@dnskr dnskr commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Why are the changes needed?

The changes are needed to unify the format used for documentation, as described in the issue #7434.

The PR also fixes broken link to Building From Source page: build.html -> building.md.

The PR does not change page contents (only very minimal visual adjustments) to ensure an easier review of the migration.
I'm planning to refine the information provided on the pages and refactor them after the migration is completed.

How was this patch tested?

Tested by building the documentation and comparing the pages against the live site.

Was this patch assisted by generative AI tooling?

Assisted-by: Qwen Coder

@github-actions github-actions Bot added the kind:documentation Documentation is a feature! label Sep 8, 2026
@dnskr
dnskr force-pushed the rst-to-md-contributing-pages branch from f8130cd to 20f1770 Compare September 8, 2026 18:54
Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
@dnskr
dnskr force-pushed the rst-to-md-contributing-pages branch from 20f1770 to 849ea92 Compare September 8, 2026 20:01

@wangzhigang1999 wangzhigang1999 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified locally. The documentation build passed without issues and looks good.

@dnskr dnskr self-assigned this Sep 9, 2026
@dnskr dnskr added this to the v1.13.0 milestone Sep 9, 2026
@dnskr dnskr closed this in cab165f Sep 9, 2026
dnskr added a commit that referenced this pull request Sep 9, 2026
### Why are the changes needed?
The changes are needed to unify the format used for documentation, as described in the issue #7434.

The PR also fixes broken link to `Building From Source` page: `build.html` -> `building.md`.

The PR **does not** change page contents (only very minimal visual adjustments) to ensure an easier review of the migration.
I'm planning to refine the information provided on the pages and refactor them after the migration is completed.

### How was this patch tested?
Tested by building the documentation and comparing the pages against the live site.

### Was this patch assisted by generative AI tooling?
Assisted-by: Qwen Coder

Closes #7717 from dnskr/rst-to-md-contributing-pages.

Closes #7717

849ea92 [Denis Krivenko] [DOC] Reformat contributing docs from RST to Markdown

Authored-by: Denis Krivenko <dnskrv88@gmail.com>
Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
(cherry picked from commit cab165f)
Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
@dnskr

dnskr commented Sep 9, 2026

Copy link
Copy Markdown
Contributor Author

Thank you for the review!

Merged to master and branch-1.12.

@dnskr dnskr changed the title [DOC] Reformat contributing docs from RST to Markdown [KYUUBI #7434][DOC] Reformat contributing docs from RST to Markdown Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:documentation Documentation is a feature!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants