jumoo / jumoo-docs

Documentation for uSync and Translation manager

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

jumoo-docs's Issues

usync blank site front page showed up in error

Using usync: 11.2.0 umbraco: 11.4.0
The following page was displayed on our high-traffic site over the weekend. Once the site was restarted, the site went back to normal.
This is most likely a failure with Umbraco that might cause this but I'd really like to understand, how I could prevent this page from showing up on issues. Or even being able to replace it with something more brand-friendly.
Are you able to give me any insight as to what the factors are that might have led to this page showing up?

Get Started (usync.complete)

uSync

• uSync.Complete
  • Get Started

Empty documentation file needs content

uSync.Complete - Add UserAgent to the Request

From vertsion v10.1

1. You can set the user agent string in config :
2. You can add your own custom header key pairs that will also get added to every request.

"uSync": {
    "Publisher": {
      "Settings": {
        "UserAgentString": "uSyncPublisherCustomString",
        "RequestHeaders": {
          "One": "ValueOne",
          "Two": "ValueTwo"
        }
   }
}

Originally posted by @KevinJump in Jumoo/uSync.Complete.Issues#184 (comment)

Broken links

The links to the "uSync Complete"-offerings in the end of this page are broken:

https://docs.jumoo.co.uk/usync/intro/

https://github.com/Jumoo/jumoo-docs/blob/master/usync/00.intro.md

GlobalLink Connector

Translation Manager

• Extending
  • Connectors
    • GlobalLink Connector

Documentation needs writing

New: DisableNotificationSuppression

Version : uSync 12
Thing: Config

From v12 uSync will use the Scope.Notifications.Suppress feature from Umbraco 12 , that means notifications for things like ContentSaved and ContrentPublished are not fired when the item is saved or published but rather in bulk at the end of an import process.

This means that notifications will fire but they won't necessary fire at the time the notification happens. this speeds up any imports because it doesn't fire events such as cache or examine rebuilds until the end of the process.

this shouldn't cause any issues but if it does you can use the Configuration option DisableNotificationSuppression to get uSync not to use the new Suppress feature, then all notifications will fire as they happen.

Default settings:

"uSync" : {
   "Settings" : {
      "DisableNotificationSuppression" : false 
    }
}

uSync.Forms

Full documentation needs writing

CreateOnly is string according to schema

https://github.com/Jumoo/jumoo-docs/blob/master/usync/06.reference/02.handlers.md

The CreateOnly value (and other settings, I guess) is a string according to the json schema, at least according to Visual Studio intellisense.

It seems to work to put a boolean there, so not sure if the documentation or the schema is wrong.

uSync Publisher settings - Realtime publisher

Umbraco 10 -> settings tab -> Extras -> Publisher
I notice that i have a "Realtime publisher" option selected by default, i try to change it but there is no other options.
My goal is to prevent umbraco10 to publish automaticly from qa to prod on save.
How can i achive this behaviour?

Languagewire

Translation Manager

• Extending
  • Connectors
    • Languagewire Connector

Documentation needs writing

New: uSync now has download export and upload import options on the menus

uSync now has extra options on the export all and import all menu items inside 'everything' group.

these items let you run an export and get a zip file.
and you can upload this zip file to another site, it will export and copy over your uSync folder and then you can run the import of the zip file over your site.

these features ofter basic zip import and export, uSync exporter offers lots more features, such as partial exports, depdendency checking etc. so if you want to do more than just copy the folder - you want/need exporter.

Wrong links in single-site config

Hi,

We are seeing something weird going on with links in RTE's properties on Umbraco 9.
Sometimes the translated variants get the wrong link.

The way we are using Translation Manager is by language variants, so multiple languages on one root node.
It looks like that the LinkResolver is looking at the default "Relate document on copy" relation.
I think that results in a wrong link if you use the package with only variants in a single root node, if you have documents that you have created by copy and rename.

As a workaround we have disabled the "Update links", but the documentation on that is wrong, it should be:

   "links": {
       "pickers": false
   },

and not

    "links": {
        "updatePicked": false,
        "updateInline": false
    },

uSync.CommandLine

Full documentation needs writing.

Document uSync.Once / uSync.Stop

uSync.Once / uSync.Stop is not documented in the latest version of the uSync docs.

Json snippet for UseFlatStructure seems to be incorrect

The following snippet from https://docs.jumoo.co.uk/usync/uSync/guides/flat seems to be incorrect:

"uSync": {
    "Sets" : {
        "Default" : {
            "UseFlatStructure": false
        }
    }
}

I think it should be:

"uSync": {
    "Sets": {
      "Default": {
        "HandlerDefaults": {
          "UseFlatStructure": false
        }
      }
    }
  }

Fundementals (uSync.Complete)

uSync

• uSync.Complete
  • Reference
    • Fundementals

Empty documentation file needs filling

uSync.Complete - ForceHost Option

Jumoo/uSync.Complete.Issues#186 (comment)

In the Publisher options
https://docs.jumoo.co.uk/usync/complete/publisher/config

there are two new things

IncludeHost

Includes the host name as part of the signiture when signing requests between sites, default is true.

Needs some warning :
Turning this value off - is in theory less secure because requests to one server (e.g stage) could be replayed on another server (e.g live) if those messages were intercepted. This is very unlikely to be possible on your setup but it is an additional risk.

ForceHostOption:

By default uSync will check signitures with an without the host name included, default value is false, if this is true then the host name will be required - as part of the sync.

uSync roots documentation

We need to turn this ramble into some docs

https://blog.jumoo.co.uk/2024/roots/

roots is part of the core uSync package, but it will probibly need 2-3 pages to explain how it works and how you use it.

Usync Migration Documentation

Doesn't exist, needs writing

New: uSync adds search query to the saved search list.

https://docs.jumoo.co.uk/usync/uSync/guides/debugging

When you install uSync you now get a new "uSync logs" entry on the log viewer page so you can click on that and get all the uSync log entires.

ImportAtStartup values examples.

Hi!

Just wanted to let you know that the "Edit this page" link on e.g. this page: https://docs.jumoo.co.uk/usync/reference/config/ does not work - it gives me a 404.

My real question or feedback was reg. this setting:

{
    "uSync": {
        "Settings": {
            "ImportAtStartup": "None"
       }
   }
}

We have this set to None during development but when we push to Test, Stage, Prod we want to run the import and create doctypes, data types, macros etc. We're not syncing any content.

I'm missing some examples or more details about the setting,

I saw this post: https://bytemeta.vip/repo/KevinJump/uSync8/issues/326 where you write yes, ImportAtStartup expects None, all, settings or content (or a combination of them). If this is still true it would be very valuable to have this in the documentation as well.

Thanks for all the great work!

"Error one or more nodes could not be created - Missing target nodes, pages may not be correctly linked" when sending more than 4 nodes for translation

Hello Kevin!

On our site we are experiencing an issue when trying to send more than 4 content nodes with 'Include children' flag for translation in the 'Bulk Translation' tab. We receive this error message:

It doesn't seem to matter how many children the nodes have.

We have set up our languages to use the Umbraco Variants feature on a single tree. The Translation Set is setup for only the root node of all our content. Master is the root node in English and Sites are all our configurable languages of the root.

If we remove content nodes to 4 or less, the 'Send to translate' will succeed.

Is this a limitation of the tool, a misconfiguration on our side or an actual bug?

Thanks in advance,
Lasse Jon