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

Rewrite root README.md file #591

Closed
wangkuiyi opened this issue Feb 6, 2018 · 4 comments
Closed

Rewrite root README.md file #591

wangkuiyi opened this issue Feb 6, 2018 · 4 comments
Assignees

Comments

@wangkuiyi
Copy link

wangkuiyi commented Feb 6, 2018

List componenets:

  1. paddlectrl (Go)
  2. paddlecloud (Python)
  3. paddlefs (PFS, Go)
  4. EDL controller (Go)

Add a figure to explain how these components interact with each other. #593

@typhoonzero
Copy link
Collaborator

I suppose the root README.md have the following structure:

  • Introduction
    • What this repo does, what it contains, what kind of ability can users get from this repo.
  • Components
    • client: paddlectl
    • paddlecloud server
    • paddlefs
    • EDL
  • User Manuals
    • link to the tutorial
    • command line reference
    • FAQs
  • Build
    • link to build EDL
    • link to build EDL controller image
    • build paddlecloud-job docker image
    • build paddlectl
  • Deploy
    • link to deploy paddlecloud
    • link to deploy EDL
    • link to deploy on minikube
  • Contribute
    How to contribute code. link to code structure and design docs.

@Yancey1989
Copy link
Collaborator

Add items:

  • Deploy
    • Link to deploy PaddleFS server
  • User Manuals
    • link to the benchmark

This was referenced Feb 7, 2018
@gongweibao
Copy link
Collaborator

Maybe we can add develop-guide like this

@typhoonzero
Copy link
Collaborator

Awesome, will update the PR.

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

4 participants