Well, uhm… maybe. There are definitely leaps of improvements that can still help. Some will come with time but others might still require just some dedicated effort. Having said that, there’s already great effort put into it and it helped me get started a few days back (even though it did feel like a hurdle upfront due to “a few repos”, “install this & that”. At the very best I’d love a “click here and do a test run” getting started, where it doesn’t customize, doesn’t persist the database maybe but at least I can play locally. And then get to a “Here’s how to install for production”
-
A dedicated “Getting started” documentation which documents the quickest way to get up and running without large deviating instructions (except for linking to “more info”). A click here, click here, run this, run that. Any deviating instructions start becoming confusing. An example is the Ayon-docker instruction to “Modify the default settings in the
settings/template.jsonfile.” When installing you have no idea what you might want to change there since you have no knowledge of the system. It’s written as if I should change something. I’d consider myself relatively technical, but as soon getting started docs start being ambiguous like that I go down a rabbit hole of “ok, so now what?”. This already goes a long way, so good job on that.- Then after the Getting Started docs you can have a lengthier walkthrough of installation and maintaining the install (like updating). But usually you’d want the very first test run of some software to have as little details as possible just to start playing and then read into more details on customizations, etc.
- From a more technical artist standpoint I’d even like a very small ‘snippet’ of commands of what you’ll roughly be doing in the end. For example at the top here I wrote a
.batscript that roughly describes my steps as I went to deploy Ayon server - I love having that handy to see “oh, so those are all the steps” (but maybe because the commands just make more sense to me since it’s super-explicit what to do technically)
-
Aside of installation, also document how to safely update. I have installed and deployed the ayon server docker, but at this point have no knowledge how to update. Also how do I kill the server data and create a new one, etc.
-
The deployment of addons (as is being worked on) can be easier without the need for manual copying.
-
This seems to miss a step on how to activate the addons - otherwise they won’t even be listed there. It misses:
You need to enable addons first in settings/addons version (soon to be replaced with more complex page with an option to install addons from packages).
- Top right > Settings > Addon Versions > Set the versions
- Now they will show in Settings > Studio Settings and also under the Manage Projects > Project Settings and Studio Settings pages.
Which was explained to me on discord here and has been asked many times before that.
I agree with the heavy development with it now still in beta it doesn’t make too much sense to create a crazy detailed tutorial video to get started - it’ll be obsolete in a few weeks. However, there’s definitely still onboarding documentation that can be improved.