facebookd360_dep - Fix and update documentation

Summary:
Fixes before open sourcing:

- Documentation will be in https://facebook.github.io/facebook360_dep
- URL links to sample data will be added as we generate it.

Reviewed By: tschrager

Differential Revision: D17557201

fbshipit-source-id: 96f0b61b7a1c2783087614c2fb80c4d6d7938740

.github/ISSUE_TEMPLATE/documentation.md

@@ -1,6 +1,6 @@
 ---
 name: "📃 Documentation Issue"
-about: Documentation issues are handled in https://github.com/facebook/facebook360_dep.github.io.
+about: Something that is wrong or missing from the documentation in https://facebook.github.io/facebook360_dep.
 title: 'Docs: '
 labels: 'Type: Docs'
 

.github/SUPPORT.md

@@ -8,7 +8,7 @@ If you have a coding question related to facebook360_dep, it might be better sui
 
 ## 📃 I found something that seems wrong in the documentation.
 
-The facebook360_dep website is hosted on a [separate repository](https://github.com/facebook/facebook360_dep.github.io). If you want to report something that is wrong or missing from the documentation, [please open a new issue there](https://github.com/facebook/facebook360_dep.github.io/issues).
+If you want to report something that is wrong or missing from the documentation, [please open a new issue there](https://github.com/facebook/facebook360_dep/issues/new?labels=Type%3A+Bug+Report&template=bug_report.md).
 
 
 ## 🐛 I found a bug in facebook360_dep.

README.md

@@ -6,16 +6,18 @@ Facebook360 Depth Estimation Pipeline (facebook360_dep) is a computational imagi
 supporting on-line marker-less calibration, high-quality reconstruction, and real-time streaming
 and rendering of 6DoF content.
 
-[![Build Status](https://travis-ci.com/facebookexternal/facebook360_dep.svg?token=cBbgb2cAy5GyFfyUqdeg&branch=master)](https://travis-ci.com/facebookexternal/facebook360_dep)
+This work is based on the 2019 SIGGRAPH Asia publication ["An Integrated 6DoF Video Camera and System Design"](https://research.fb.com/publications/an-integrated-6dof-video-camera-and-system-design/).
+
+[![Build Status](https://travis-ci.com/facebook/facebook360_dep.svg?token=cBbgb2cAy5GyFfyUqdeg&branch=master)](https://travis-ci.com/facebook/facebook360_dep)
 [![Build Status](https://img.shields.io/badge/license-BSD-green.svg)](LICENSE)
 
 ## Contents
 
 - [Requirements](#-requirements)
-- [Building facebook360_dep](#-building-facebook360_dep)
 - [Documentation](#-documentation)
 - [How to Contribute](#-how-to-contribute)
-- [Code of Conduct](#-code-of-conduct)
+- [Code of Conduct](#code-of-conduct)
+- [Support](#-support)
 - [License](#-license)
 
 ## 📋 Requirements
@@ -28,7 +30,7 @@ software pipeline. Certain capabilities are restricted on the operating systems,
 
 Here you can find short guides for the most common scenarios: [facebook360_dep][tutorial].
 
-[tutorial]: https://facebook360_dep.github.io/docs/tutorial.html
+[tutorial]: https://facebook.github.io/facebook360_dep/docs/tutorial.html
 
 ## 👏 How to Contribute
 
@@ -51,6 +53,12 @@ We have a list of [good first issues][gfi] that contain bugs which have a relati
 
 [gfi]: https://github.com/facebook/facebook360_dep/labels/good%20first%20issue
 
+## Support
+
+If you need help with your facebook360_dep app, the right place to go depends on the [type of help that you need][supp].
+
+[supp]: https://github.com/facebook/facebook360_dep/blob/master/.github/SUPPORT.md
+
 ## 📄 License
 
 facebook360_dep is BSD licensed, as found in the [LICENSE](LICENSE) file.

docs/data.md

@@ -22,13 +22,13 @@ test in the cloud to avoid having to deal with excessive render times or local d
 - **Rendered Frame Sequence**: A sample render of the frame sequence to show what the output looks like.
 
 ### The Complex
-- **Single Frame**: s3://facebook360-dep-sample-data/the_complex/1_frame_unpacked
-- **Rendered Single Frame**: s3://facebook360-dep-sample-data/the_complex/1_frame_unpacked_rendered
-- **Frame Sequence**: s3://facebook360-dep-sample-data/the_complex/20_frames
-- **Rendered Frame Sequence**: s3://facebook360-dep-sample-data/the_complex/20_frames_rendered
+- **Single Frame**: coming soon
+- **Rendered Single Frame**: coming soon
+- **Frame Sequence**: coming soon
+- **Rendered Frame Sequence**: coming soon
 
 ### Room Chat
-- **Single Frame**: s3://facebook360-dep-sample-data/room_chat/1_frame_unpacked
-- **Rendered Single Frame**: s3://facebook360-dep-sample-data/room_chat/1_frame_unpacked_rendered
-- **Frame Sequence**: s3://facebook360-dep-sample-data/room_chat/50_frames
-- **Rendered Frame Sequence**: s3://facebook360-dep-sample-data/room_chat/50_frames_rendered
+- **Single Frame**: coming soon
+- **Rendered Single Frame**: coming soon
+- **Frame Sequence**: coming soon
+- **Rendered Frame Sequence**: coming soon

website/pages/en/index.js

@@ -56,7 +56,7 @@ class HomeSplash extends React.Component {
         <Logo img_src={`${baseUrl}img/dep_logo.png`} />
         <div className="inner">
           <PromoSection>
-            <Button href="https://github.com/facebookexternal/facebook360_dep">Start Hacking</Button>
+            <Button href="https://github.com/facebook/facebook360_dep">Start Hacking</Button>
             <Button href="/docs/install">Tutorial</Button>
           </PromoSection>
         </div>

website/siteConfig.js

@@ -5,24 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-// See https://docusaurus.io/docs/site-config for all the possible
-// site configuration options.
-
 const siteConfig = {
-  title: 'facebook360_dep', // Title for your website.
+  title: 'facebook360_dep',
   tagline: 'Facebook360 Depth Estimation Pipeline',
-  url: 'https://your-docusaurus-test-site.com', // Your website URL
-  baseUrl: '/', // Base URL for your project */
-  // For github.io type URLs, you would set the url and baseUrl like:
-  //   url: 'https://facebook.github.io',
-  //   baseUrl: '/test-site/',
+  url: 'https://facebook.github.io',
+  baseUrl: '/', // Base URL for your project
 
   // Used for publishing and more
   projectName: 'facebook360_dep',
   organizationName: 'facebook',
-  // For top-level user or org sites, the organization is still the same.
-  // e.g., for the https://JoelMarcey.github.io site, it would be set like...
-  //   organizationName: 'JoelMarcey'
 
   // For no header links in the top nav bar -> headerLinks: [],
   headerLinks: [
@@ -31,38 +22,21 @@ const siteConfig = {
     {doc: 'api', label: 'API Reference'},
     {doc: 'roadmap', label: 'Roadmap'},
     {doc: 'faqs', label: 'Help'},
-    {href: 'https://github.com/facebookexternal/facebook360_dep', label: 'GitHub'},
+    {href: 'https://github.com/facebook/facebook360_dep', label: 'GitHub'},
   ],
 
-  // If you have users set above, you add it here:
-  // users,
-
   /* path to images for header/footer */
   headerIcon: 'img/favicon.ico',
   footerIcon: 'img/favicon.ico',
   favicon: 'img/favicon.ico',
 
-  /* Colors for website */
+  // Colors for website
   colors: {
     primaryColor: '#4267B2',
     secondaryColor: '#5890ff',
   },
 
-  /* Custom fonts for website */
-  /*
-  fonts: {
-    myFont: [
-      "Times New Roman",
-      "Serif"
-    ],
-    myOtherFont: [
-      "-apple-system",
-      "system-ui"
-    ]
-  },
-  */
-
-  // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
+  // Copyright info
   copyright: `Copyright © ${new Date().getFullYear()} Facebook Inc.`,
 
   highlight: {
@@ -87,10 +61,6 @@ const siteConfig = {
 
   // Show documentation's last update time.
   // enableUpdateTime: true,
-
-  // You may provide arbitrary config keys to be used as needed by your
-  // template. For example, if you need your repo's URL...
-  //   repoUrl: 'https://github.com/facebook/test-site',
 };
 
 module.exports = siteConfig;