Add some docs about how to set up local dev env

Open Beginner friendly
#3,758 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
java
Domain
developer-experience, documentation

Research direction

Look for existing documentation files in the repository, likely in a docs/ or README.md. The issue mentions specific build steps for the OpenMLDB project: the need to run 'make' before 'mvn compile', skipping certain Maven plugins, and handling HTTP repository issues with Maven 3.8.1+. Start by checking the project's build instructions and see where these steps are missing. The goal is to add a new section or file explaining local development setup, including the commands and configuration snippets provided.

Written by the indexing model from the issue text.

Description

documentation

Describe the feature you'd like

A clear and concise description of what you want to happen.

目前整个代码库项目比较多，依赖语言和环境也比较复杂，通过目前的文档可以较为顺利地安装和部署，但是如果需要进行本地调试开发，相关编译调试文档还是比较欠缺的，希望可以补充相关文档降低开发环境配置门槛。

Additional context

Add any other context or screenshots about the feature request here.

目前找不到相关文档阐述开发环境编译配置，例如：

  1. openmldb项目的mvn compile 等操作之前需要先进行 make 操作，
  2. openmldb项目的 mvn install 等操作会触发 gpg, scalatest 等插件运行，在本地执行一般会失败，需要skip相关插件，可以配置install -Dgpg.skip -DskipTests=true -Dwagon.skip=true -Dmaven.test.skip=true -f pom.xml
  3. 3.8.1及以后的maven不支持http repository，项目使用的 confluent repo(https://packages.confluent.io/maven) 中相关库会出现下载失败等情况，可以使用以下方式解决：
    3.1 maven降级
    3.2 maven settings.xml 中增加 mirror 配置
    <mirror>
            <id>maven-default-http-blocker</id>
            <url>http://127.0.0.1/dont-go-here</url>
            <mirrorOf>dummy</mirrorOf>
            <blocked>false</blocked>
        </mirror>
Dominant language
C++
Stars
1.7k
Forks
331
Avg merge
12d 12h
Merged PRs (30d)
1

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.

More from 4paradigm/OpenMLDB

All issues in 4paradigm/OpenMLDB

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.