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

Add guide for documentation-2-"安装与编译" #8211

Closed
shanyi15 opened this issue Feb 7, 2018 · 1 comment
Closed

Add guide for documentation-2-"安装与编译" #8211

shanyi15 opened this issue Feb 7, 2018 · 1 comment
Assignees

Comments

@shanyi15
Copy link
Collaborator

shanyi15 commented Feb 7, 2018

  • Task
    Here is the reclassified documentation structure, please add a guide for "安装与编译", introducing what is "安装与编译" , and the general idea/function/target reader of each part.("安装与运行"and“从源码编译”)

请注意:"安装与编译"其中的两篇文档随后会合并为一篇,请参考https://github.com/PaddlePaddle/Paddle/issues/8273, 最后,安装与编译应该包括三篇文档:

使用pip安装
使用Docker安装运行
从源码编译(docker环境)

概述应与文档结构保持一致~

  • What is guide?
    It is an introduction of each part of one module, also, a brief introduction of this module is necessary. Take TensorFlow for example:
    image

  • Note
    Language:
    Please write in Chinese.
    Timeline:
    Draft: 1st Mar
    Review: 8th Mar
    Deadline:15th Mar
    Documentation structure mind map:
    mind map_cn
    mind map_en
    请注意
    直接改类似 doc/howto/capi/index_cn.rst的rst文件,不是新加一个md文件

  • Background

About guide, we have discussed in our MRD, see page 6

Our goal is to make it clear and understandable for developers to use.

English version is also necessary, however, our plan is writing Chinese version this time.

Thank you so much!


Project Background
Optimize documentation of PaddlePaddle, enhancing user experience
-----Enhancement Plan: Stage 1 MRD
-----Enhancement Schedule(Update everyday)
-----Guide-adding Plan

@shanyi15
Copy link
Collaborator Author

shanyi15 commented Feb 8, 2018

@pkuyym Issue更新了一部分

请注意:"安装与编译"其中的两篇文档随后会合并为一篇,请参考#8273, 最后,安装与编译应该包括三篇文档:

使用pip安装
使用Docker安装运行
从源码编译(docker环境)

概述应与文档结构保持一致~

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

No branches or pull requests

2 participants