apache / apache/doris-website

[Docs] Suggestion: Improve the Docker compilation guide

Open
#3,540 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
133
Forks
464
Avg merge
1d 1h
Merged PRs (30d)
50

Description

Hello, maintainers,

I recently tried to compile Doris with Docker and, while following the [documentation](https://doris.apache.org/community/source-install/compilation-with-docker), I felt that this page still has room for improvement in terms of structure and readability.

My main concern is that the current page mixes several different kinds of information into one linear flow, including:

- Mapping between Doris version and build image
- ARM64-related notes
- JDK switching notes
- the `docker run` command and parameter explanation
- the actual build steps

As a result, the main build path feels harder to follow than it needs to be, especially for users who follow the documentation step by step and tend to reuse commands directly.

I looked at the Docker build documentation of [a similar open-source project](https://docs.starrocks.io/docs/developers/build-starrocks/Build_in_docker) and found its structure quite clear.

I am not suggesting copying that page directly, but I think some of its documentation pattern may be worth considering for Doris, for example:

- using placeholders in the main workflow instead of exposing readers long version-specific commands immediately
- splitting the long `docker run` command into multiple lines to make it easier to read and modify
- separating the default build path from optional notes and variations
- making the main workflow more linear, for example: choose image -> clone source -> run container -> enter container -> build

I think this could make the page easier to understand for first-time contributors and for users who want to reproduce the build environment with fewer mistakes.

I would like to hear maintainers' thoughts on this direction first. If this approach makes sense, I would be happy to help refine the documentation based on the discussion.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.