add docs

autoai-org · Nov 11, 2018 · d966701 · d966701
1 parent 524e086
commit d966701
Show file tree

Hide file tree

Showing 7 changed files with 801 additions and 458 deletions.
diff --git a/Makefile b/Makefile
@@ -19,7 +19,7 @@ format:
 	# yapf -i cvpm/**/*.py
 
 docs:
-	npm run docs:build
+	cd docs && npm run docs:build
 
 package:
 	python setup.py sdist bdist_wheel

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -1,120 +1,133 @@
 module.exports = {
-    dest: 'docs/dist',
+  dest: 'dist',
+  locales: {
+    '/': {
+      lang: 'en-US',
+      title: 'CVPM',
+      description: 'Package Manager for Computer Vision'
+    },
+    '/zh-CN/': {
+      lang: 'zh-CN',
+      title: 'CVPM',
+      description: '用于计算机视觉的包管理'
+    }
+  },
+  head: [
+    ['link', { rel: 'icon', href: `/logo.png` }],
+    ['link', { rel: 'manifest', href: '/manifest.json' }],
+    ['meta', { name: 'theme-color', content: '#3eaf7c' }],
+    ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
+    ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
+    ['link', { rel: 'apple-touch-icon', href: `/icons/apple-touch-icon-152x152.png` }],
+    ['link', { rel: 'mask-icon', href: '/icons/safari-pinned-tab.svg', color: '#3eaf7c' }],
+    ['meta', { name: 'msapplication-TileImage', content: '/icons/msapplication-icon-144x144.png' }],
+    ['meta', { name: 'msapplication-TileColor', content: '#000000' }]
+  ],
+  serviceWorker: true,
+  themeConfig: {
+    repo: 'unarxiv/cvpm',
+    editLinks: true,
+    lastUpdated: 'Last Updated',
+    docsDir: 'docs',
     locales: {
       '/': {
-        lang: 'en-US',
-        title: 'CVPM',
-        description: 'Package Manager for Computer Vision'
+        label: 'English',
+        selectText: 'Languages',
+        editLinkText: 'Edit this page on GitHub',
+        serviceWorker: {
+          updatePopup: {
+            message: "New Content is Available.",
+            buttonText: "Refresh"
+          }
+        },
+        nav: [
+          {
+            text: 'Guide',
+            link: '/en-US/guide/',
+          },
+          {
+            text: 'Blog',
+            link: 'https://blog.cvtron.xyz/'
+          },
+          {
+
+            text: 'Status',
+            link: 'https://status.cvtron.xyz/'
+          },
+          {
+            text: 'Forum',
+            link: 'https://forum.cvtron.xyz/'
+          },
+          {
+            text: 'Community',
+            items: [
+              { text: 'CVTron', link: 'https://github.com/unarxiv/CVTron' }
+            ]
+          }
+        ],
+        sidebar: {
+          '/en-US/guide/': genSidebarConfig('Guide')
+        }
       },
       '/zh-CN/': {
-        lang: 'zh-CN',
-        title: 'CVPM',
-        description: '用于计算机视觉的包管理'
-      }
-    },
-    head: [
-      ['link', { rel: 'icon', href: `/logo.png` }],
-      ['link', { rel: 'manifest', href: '/manifest.json' }],
-      ['meta', { name: 'theme-color', content: '#3eaf7c' }],
-      ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
-      ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
-      ['link', { rel: 'apple-touch-icon', href: `/icons/apple-touch-icon-152x152.png` }],
-      ['link', { rel: 'mask-icon', href: '/icons/safari-pinned-tab.svg', color: '#3eaf7c' }],
-      ['meta', { name: 'msapplication-TileImage', content: '/icons/msapplication-icon-144x144.png' }],
-      ['meta', { name: 'msapplication-TileColor', content: '#000000' }]
-    ],
-    serviceWorker: true,
-    themeConfig: {
-      repo: 'unarxiv/cvpm',
-      editLinks: false,
-      lastUpdated: 'Last Updated',
-      docsDir: 'docs',
-      locales: {
-        '/': {
-          label: 'English',
-          selectText: 'Languages',
-          editLinkText: 'Edit this page on GitHub',
-          nav: [
-            {
-              text: 'Guide',
-              link: '/en-US/guide/',
-            },
-            {
-              text: 'Blog',
-              link: 'https://blog.cvtron.xyz/'
-            },
-            {
-
-              text: 'Status',
-              link: 'https://status.cvtron.xyz/'
-            },
-            {
-              text: 'Forum',
-              link: 'https://forum.cvtron.xyz/'
-            },
-            {
-              text: 'Community',
-              items: [
-                { text: 'CVTron', link: 'https://github.com/unarxiv/CVTron' }
-              ]
-            }
-          ],
-          sidebar: {
-            '/en-US/guide/': genSidebarConfig('Guide')
+        label: '简体中文',
+        selectText: '选择语言',
+        lastUpdated: '上次更新',
+        editLinkText: '在 GitHub 上编辑此页',
+        serviceWorker: {
+          updatePopup: {
+            message: "发现新内容可用.",
+            buttonText: "刷新"
           }
         },
-        '/zh-CN/': {
-          label: '简体中文',
-          selectText: '选择语言',
-          lastUpdated: '上次更新',
-          editLinkText: '在 GitHub 上编辑此页',
-          nav: [
-            {
-              text: '指南',
-              link: '/zh-CN/guide/',
-            },
-            {
-              text: '博客',
-              link: 'https://blog.cvtron.xyz/'
-            },
-            {
-
-              text: '状态',
-              link: 'https://status.cvtron.xyz/'
-            },
-            {
-
-              text: '论坛',
-              link: 'https://forum.cvtron.xyz/'
-            },
-            {
-              text: '社群',
-              items: [
-                { text: 'CVTron', link: 'https://github.com/unarxiv/CVTron' },
-              ]
-            }
-          ],
-          sidebar: {
-            '/zh-CN/guide/': genSidebarConfig('指南')
+        nav: [
+          {
+            text: '指南',
+            link: '/zh-CN/guide/',
+          },
+          {
+            text: '博客',
+            link: 'https://blog.cvtron.xyz/'
+          },
+          {
+
+            text: '状态',
+            link: 'https://status.cvtron.xyz/'
+          },
+          {
+
+            text: '论坛',
+            link: 'https://forum.cvtron.xyz/'
+          },
+          {
+            text: '社群',
+            items: [
+              { text: 'CVTron', link: 'https://github.com/unarxiv/CVTron' },
+            ]
           }
+        ],
+        sidebar: {
+          '/zh-CN/guide/': genSidebarConfig('指南')
         }
       }
     }
   }
-
-  function genSidebarConfig (title) {
-    return [
-      {
-        title,
-        collapsable: true,
-        children: [
-          '',
-          'getting-started',
-          'install-package',
-          'write-package',
-          'contributing',
-          'credits'
-        ]
-      }
-    ]
-  }
+}
+
+function genSidebarConfig(title) {
+  return [
+    {
+      title,
+      collapsable: true,
+      children: [
+        '',
+        'getting-started',
+        'install-package',
+        'write-package',
+        'discovery',
+        'contributing',
+        'credits'
+      ]
+    }
+  ]
+}
diff --git a/docs/en-US/guide/discovery.md b/docs/en-US/guide/discovery.md
@@ -0,0 +1,45 @@
+# Discovery
+
+## Overview
+
+Discovery is one of the most important part of cvpm, which allows thirdparties to provide model registries on their behalf, users to query models with SDKs and etc.
+
+It is an open source service, locates in the ```discovery``` folder, and deployed as a docker-based distributed service for use. 
+
+## Infrastructure
+
+Thanks to our generous [sponsors](https://cvpm.autoai.org/en-US/guide/credits.html), we could be able to deploy and maintain our discovery services on various kind of cloud services. 
+
+Our main infrastructure depends on the following cloud services:
+
+* **AWS DynamoDB** for providing database.
+* **Open Stack** for providing virtual machines.
+* **Docker Cloud** for providing container build and deploy services. 
+* **Cloudflare** for DNS.
+
+### Region
+
+Our servers locates in difference regions and by using load balancer, it should be able to help users in different areas with enjoying the benefit. We now support the following supported area:
+
+* **Hong Kong** (Provided by Cyberport Hong Kong)
+* **Mainland China** (Provided by Tencent Cloud)
+* **Nova, US** (Provided by Open Source Lab, Oregon State University)
+
+But for now, our storage service in only available in the following area and our intranet.
+
+* **Nova, US**(Provided by Open Source Lab, Oregon State University)
+* **Mainland China** (Provided by DiDi Cloud)
+
+Other *paid* models are currently served by Amazon S3 and therefore have a better bandwidth support.
+
+## Services
+
+Our Discovery Service provides the following services:
+
+* **Model Discovery**
+* **Registry Management**
+* **Pretrained Discovery**
+* **User Authentication**
+* 
+
+## API Reference