We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
按照教程构建文档后,将产生大约 10000+ 改动的文件。
其中:
output/
.gitignore
docs/api/paddle/*_cn.rst
COPY-FROM
docs/practices
docs/guides
ipynb
md
png
这部分的构建后改动会导致每次构建破坏原有的仓库文件信息,从而不利于在开发文档时构建测试。
在更极端情况中,如果进行修改后,未提交更改就进行了构建,则其修改内容很可能被覆盖或丢失,从而增加修改成本。
对于 output 与英文文档部分,已添加 gitignore 解决 #6231 其余中文文档更新与 ipynb 部分,尚未解决,或许需要添加临时目录以供构建等,如添加 build 目录,复制所有要改动的文件到其中完成改动。
output
gitignore
build
附1 构建命令不明确:README 教程中的构建指引,采用 bash docs-build.sh -f absolute_path_docs 方法,略显不直观,能否考虑基于 docs-build.sh 计算路径,或使用 pwd 等方法直接获取,避免这里造成不确定填 <PROJECT_ROOT>/docs 还是 <PROJECT_ROOT>
bash docs-build.sh -f absolute_path_docs
docs-build.sh
pwd
<PROJECT_ROOT>/docs
<PROJECT_ROOT>
附2 权限非预期:构建过程由于基于 docker 进行,生成的文件都是 root 用户所有的,导致低权限状态下无法修改、删除相关文件
docker
root
附3 临时绕开文件变动方法:
rm -rf output/ docs/api/paddle/ docs/guides/ docs/inference_api/ docs/practices/ # 需要 root 权限 git reset HEAD --hard
@sunzhongkai588 @SigureMo
The text was updated successfully, but these errors were encountered:
No branches or pull requests
文档链接&描述 Document Links & Description
按照教程构建文档后,将产生大约 10000+ 改动的文件。
其中:
output/
新增,由于该路径未位于.gitignore
中,因此未忽略;docs/api/paddle/*_cn.rst
中COPY-FROM
块的更新docs/practices
和docs/guides
中,ipynb
被移除,构建为新增的md
和png
这部分的构建后改动会导致每次构建破坏原有的仓库文件信息,从而不利于在开发文档时构建测试。
在更极端情况中,如果进行修改后,未提交更改就进行了构建,则其修改内容很可能被覆盖或丢失,从而增加修改成本。
请提出你的建议/提个PR修复这个问题 Please give your suggestion/update a PR to fix it
对于
output
与英文文档部分,已添加gitignore
解决 #6231其余中文文档更新与
ipynb
部分,尚未解决,或许需要添加临时目录以供构建等,如添加build
目录,复制所有要改动的文件到其中完成改动。附1 构建命令不明确:README 教程中的构建指引,采用
bash docs-build.sh -f absolute_path_docs
方法,略显不直观,能否考虑基于docs-build.sh
计算路径,或使用pwd
等方法直接获取,避免这里造成不确定填<PROJECT_ROOT>/docs
还是<PROJECT_ROOT>
附2 权限非预期:构建过程由于基于
docker
进行,生成的文件都是root
用户所有的,导致低权限状态下无法修改、删除相关文件附3 临时绕开文件变动方法:
rm -rf output/ docs/api/paddle/ docs/guides/ docs/inference_api/ docs/practices/ # 需要 root 权限 git reset HEAD --hard
@sunzhongkai588 @SigureMo
The text was updated successfully, but these errors were encountered: