Website: Write the Flamenco Upgrading Guide #104324
Labels
No Label
Good First Issue
Priority
High
Priority
Low
Priority
Normal
Status
Archived
Status
Confirmed
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Job Type
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: studio/flamenco#104324
Loading…
Reference in New Issue
Block a user
No description provided.
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
While navigating on the website I noticed that the upgrading docs has a TODO text in it.
I'd like to write it, this is a draft that I'd like to propose and discuss:
Upgrading Flamenco
3.1 Inside the Manager, in the top-right corner download the new Blender addon.
3.2 In Blender, reinstall the addon. After intalling it, you should see the version change.
3.2.1 In the addon panel, check your preferences and press the refresh button on the Manager URL field.
4.1 Run them again, so they get registred on the Manager.
Thanks!
I wouldn't call this a "safety measure", as it scares away people from upgrading. I've already had to close bug reports because they were reporting things that were already fixed, but the reporters didn't know because they hadn't upgraded.
Something like "To ensure jobs are rendered consistently, …" would be a bit friendlier.
Before Manager should be run, the downloaded ZIP file needs to be extracted somewhere. Where this is done is kinda vital, as doing it in any place but the original location will make the Manager not find its config nor its database, and thus think it's a brand new setup.
I would recommend stopping the entire farm, so Manager + Workers, in one go. And then upgrade the files, then restart them.
They should not have to register. If the upgrade is done well, they can just sign in with the existing credentials.
Hi, I updated the steps with your feedback and changed it a bit to make it more clear.
I also added new steps such as a backup option if the user would like to keep their previous version installed. Its a practice that I usually do myself, I always append something like "old" or "backup" at the end of the file or folder in case I need to quickly revert.
Upgrading Flamenco
6.1 Inside the Manager, in the top-right corner download the updated Blender addon.
7.1 Inside the addon panel, check your preferences and press the refresh button on the Manager URL field.
8.1 Run them again, they should reuse their stored credentials and sign in to the Manager.
Getting better! Thanks for putting in the effort.
This is going to cause issues, because renaming the directory means that your new install is going to run from a directory that doesn't have the task logs, sqlite file, etc.
I think it's a good idea to describe how to create backups of a Flamenco install. I think it'll be clearer when that is done in a section of its own. This guide can then link to that for reference. But for now, just skip the backup part -- once it's written, it's easy enough to add a link here.
"replace" → "place". You're not replacing the contents of the ZIP, you're replacing something else with the contents of that ZIP.
One thing that I've seen people confused by (well, to be fair, only one person) is that after the initial run of Flamenco Manager, it doesn't automatically open a webbrowser any more. So maybe add something like "Open the Flamenco webapp in your browser" or something along those lines.
"installing"
I think this can be removed. Generally people don't know that there are credentials at all anyway. Maybe something like "Run them again, they should sign in to the Manager like before" is enough.
👍 Nice, thanks!!
I agree, I wasn't thinking very thoroughly when I wrote about renaming the directory, so I installed Flamenco in a virtual machine to follow along with the steps to see if they made sense and indeed renaming the manager directory would be a bad idea.
Cool, I'll wait until we polish our final version of the upgrade guide to write backup methods and them link it as suggested.
I updated with place, what I meant before with replace would be a overwrite, that you should extract and overwrite the contents with the ones from the ZIP, I'm not sure if that would sound better?
Got it, yeah I remember seeing that issue report.
😅 Oops I read it multiple times and still missed that, this time I processed the text with the help of a online grammar tool.
Done, I went with "...to the Manager as usual" because I thought it would sound a bit nicer but please let know what you think.
Upgrading Flamenco
5.1 Inside the Manager, in the top-right corner, download the updated Blender add-on.
6.1 Inside the add-on panel, check your preferences and press the refresh button on the Manager URL field.
7.1 Run them again, they should sign in to the Manager as usual.
Yeah, I think you're right, it'll be nice if this describes that it should overwrite the existing files.
For me "the newer version" sounds like there is also an option to run "the older version", but that's not there any more. I think it's fine to just say "Run the Flamenco Manager executable". Or maybe "Run the updated Flamenco Manager executable", or something along those lines.
Would this make sense as a "5.1" step? And then what is now "5.1" can become "5.2".
I like the sub-steps, because it helps to separate the "this is what you do with the Manager", "then Blender", "then the Worker".