hubs-foundation / hubs-docs Goto Github PK
View Code? Open in Web Editor NEWLicense: Other
License: Other
See conversation in Discord here: https://discordapp.com/channels/498741086295031808/715710114438447114/754688688243605555
And related Hubs Cloud issue: Hubs-Foundation/hubs-cloud#62
In the "Room Settings" page, second paragraph, there's a "content curation guidelines" link to the page: https://hubs.mozilla.com/docs/creators-content-guidelines.html But thus page has no content.
The code to add the search bar to the Hubs documentation site (which I believe is here: https://github.com/MozillaReality/hubs-docs/blob/master/website/siteConfig.js#L60) is present but currently commented out. When we last looked into adding the search to the site, the code worked fine for local instances of the codebase but had CSP issues when deploying to the live site.
Adding search would likely reduce the number of questions that we get through other channels, since users would have an easier time looking through the current documentation to find an answer for their issues.
"Supported Devices & Browsers" section and below are not displayed in
https://hubs.mozilla.com/docs/hubs-create-join-rooms.html
Perhaps it could be caused with this commit.
I guess multiple lines commenting out may not work.
Add a welcome/introduction type article at the top of articles: orientate people first coming to that section, telling them what that documentation will allow them to achieve, who it is for, what it's about, etc. I'd advise putting a similar introduction type article at the top of all the sections, particularly:
Hubs Documentation - Consider "Hubs user guide" or similar since all of this documentation falls under the branch of 'Hubs Documentation'
Spoke Documentation - say what spoke is, who it is for, and what kinds of things you can do with it. What is the basic stuff people will want to try, and what are the most advanced bits to go onto later on
For Creators - May not be clear who this document is for
For Developers - Audience here may not be clear; it's also not clear if/how Hubs Cloud documentation is different than the general developer resources
I'm interested in whether these docs are (or could be) multilang, and if so, how to contribute a Spanish translation to some sections.
Currently we don't rewrite the url to the correct file or even show a 404 page when the .html extension is omitted. We should fix this.
To complement the warning banner in the admin panel.
As a reader of the "Domain Recipes" page I would like to have more clarity as to which tlds are ok for recipe 1 in order to have 0 doubt on whether I can buy a domain on Route 53 and get started.
As I was following the quick start guide and went through the domain recipes, in particular recipe 1, I found the documentation text to be just a tiny bit unclear on the fact that ".com" and ".link" are placeholders, and can be replaced by other top-level domains (tld), say ".io" or ".co", and since this step costs money, it could/should be improved.
Small hints that overall created my doubt:
I eventually went forward and can clarify that it is indeed perfectly ok to have a ".co" instead of ".com" for instance, while using Recipe 1.
Currently, it writes:
Known bug + fix: Using a second level domain (.co.uk, .com.fr, etc)? Use Recipe 3.
Instead it could write:
".com" and ".link" can be replaced by other top-level domains at your convenience, eg. ".co", ".io" etc.
Known bug + fix: Using a second level domain (.co.uk, .com.fr, etc)? Use Recipe 3.
Aside from this, I also found:
mysite.com set up on on Route 53 (?)
What is the (?) doing here?
I would be happy to submit a quick PR if someone doubles-check my language prior to it since I am not a native English speaker.
Let me know what I can clarify, in the meantime, my domains got approved, the transfer lock got disabled and my stack got successfully deployed ๐ ๐
I want to know the possibility of translating Hubs Mozilla to the PT-BR language so that we Brazilians can use this platform in a more friendly way to our language.
The "hubs controls" page should include instructions for toggling fly mode.
In aws stack creation and troubleshooting documentation, write a blurb about disabling aws's "Transfer Lock"
We can improve the onboarding process for external contributors to the hubs docs site if we make the readme highlight the non-cloning path for contribution (e.g. "Click "edit" on the page you want to edit, make changes, how to add an image, submit for review as a patch)
We want to encourage users to enable CloudTrail for their own auditing purposes. Some instructional documentation around that would be useful.
The Intro to Hubs Cloud page has a link to a non-existent digital ocean quick start guide:
https://github.com/MozillaReality/hubs-docs/blob/fa00f4ee8c6d560407465dc70cedf0a855dc5890/docs/hubs-cloud-intro.md
It'd be nice to have a guide with some basic tips on how to create a scene with good performance.
From: Hubs-Foundation/hubs#4040
Currently we intentionally disable camera recording feature on MacOS/iOS. But we haven't documented it anywhere.
I think we should mention it in https://hubs.mozilla.com/docs/hubs-features.html
[Affected Versions]:
[Affected Platforms]:
[Prerequisites]:
[Steps to reproduce]:
[Expected results]:
[Actual results]:
[Notes]:
Some areas of the world have different requirements for where participant data can be stored and accessed from. We should have a document somewhere that outlines which services for Hubs Cloud are restricted to different regions, so that organizations with data storage and transmission requirements would be able to determine the viability of Hubs Cloud for specific use cases.
(Re-created from Hubs-Foundation/hubs-cloud#12)
From deployment issues, it's not clear when to use Recipe 3 vs use Hosted zone when you just purchased a domain from a domain registrar like namecheap or godaddy. Update docs to reflect this.
This came up on the Hubs Discussions forum so I'm recording it here for our records - Hubs-Foundation/hubs#2982
Thank you for the positive feedback! If I could throw in my bit on this, a simple document stating how to rebuild the client on AWS would go a long way for me. Thinking ahead, that would be really useful for many people. Right now, this document is not enough - its a vital subject, I get to half way the cant go forward after the prerequisites section: https://hubs.mozilla.com/docs/hubs-cloud-custom-clients.html
It would be nice to have a document stating the steps and the requirements.
Again, thank you for your interest.
From discussion: Hubs-Foundation/hubs#3043
How to whitelist just the servers needed for the necessary port range so network security isn't compromised.
From @larsbergstrom : consider updating https://hubs.mozilla.com/docs/intro-avatars.html
to include pointers to online avatar creators.
This will also include documentation for the blender add-on when it is published
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.