Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

细微改进 #666

Open
wants to merge 1 commit into
base: develop-astro-nacos
Choose a base branch
from

Conversation

FirokOtaku
Copy link

What is the purpose of the change

优化几处文档细节.

Brief changelog

这也不是代码是唯一有贡献项目的方式。

开源共建 - 贡献源码 章节语句存在细微的语句不通顺问题.

该网站服务于http://nacos.io。

您将在“http://localhost:4321/”中看到网站。

readme 中存在链接格式不当问题, 导致 GitHub 的 Markdown 渲染器渲染结果不正确

概述部分

Maven 坐标

<dependency>
    <groupId>com.alibaba.nacos</groupId>
    <artifactId>nacos-client</artifactId>
    <version>${version}</version>
</dependency>

用户指南 - Java 的 SDK 章节的概述部分 Maven 坐标使用了 ${version} 占位符.

这不是一个 错误, 但如果用户忘记将占位符替换为实际 nacos-client 版本号, 这会引用到用户 pom.xml 的 version 字段; 当 Maven Central 中恰巧包含一个匹配用户 pom.xml 中 version 字段的 nacos-client 依赖时, Maven 将 正常 拉取到一个 可能不正常 的依赖, 但用户可能 不能及时发现这里潜在的问题.

比如我自己的 pom.xml 里写的 version0.1.0, 忘了替换掉 nacos-client 的占位符, 完事 Maven Central 真的包含一个 0.1.0 版本的 nacos-client. 这个 0.1.0 版本 nacos-client 在调试时, 前面一切正常, 能正常连接 Nacos 服务器拉取配置, 但是就是没法注册服务. 调了几个小时才发现是依赖版本号的问题, 吐了.

此 PR 将文档中原本的 ${version} 替换为一个大概率不会已存的占位符 ${NACOS-VERSION} 来帮助用户尽早发现依赖版本配置问题.

@CLAassistant
Copy link

CLAassistant commented May 17, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@KomachiSion KomachiSion left a comment

Choose a reason for hiding this comment

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

  1. latest无需更新, 请更新到next下。
  2. guide/user已进入归档阶段,建议修改manual/user下的对应文档
  3. sdk的version 我觉得不需要修改吧,应该不太会造成误解,如果一定要改的话,旧修改成nacos.client.version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants