From 667625c111f48a902860fc82c12be849ddd35bc5 Mon Sep 17 00:00:00 2001 From: "aron.lakatos" Date: Mon, 27 Feb 2017 14:57:53 +0000 Subject: [PATCH] fixing typos, capitalisation, repeated words; rephrasing sentences --- docs/action-file.md | 19 ++++++++--------- docs/backoffice-config.md | 36 ++++++++++++++++---------------- docs/contentedition.md | 32 ++++++++++++++--------------- docs/core-config.md | 43 +++++++++++++++++++-------------------- docs/getting-started.md | 24 +++++++++++----------- docs/handler-config.md | 18 ++++++++-------- docs/index.md | 4 ++-- docs/install.md | 4 ++-- docs/usync-project.md | 18 ++++++++-------- docs/versions.md | 13 ++++++------ 10 files changed, 104 insertions(+), 107 deletions(-) diff --git a/docs/action-file.md b/docs/action-file.md index 70cebffe..25bf6117 100644 --- a/docs/action-file.md +++ b/docs/action-file.md @@ -1,30 +1,29 @@ # uSync Action File -The usync action file +The uSync action file ```bash uSyncActions.config ``` -Is placed in the root of the uSync folder when ever a delete (or certain type of rename) +Is placed in the root of the uSync folder whenever a delete (or certain type of rename) is detected by uSync. -The action file is used on imports to make sure we delete things that are no longer -needed on the umbraco site. +The action file is used on imports to make sure we delete things that are no longer needed on the Umbraco site. # Full Exports -When you perform a full export everything is cleaned from the disk, and recreated as -an export - prior to v3.2.3 exports would wipe the uSyncActions.config file as part +When you perform a full export, everything is cleaned from the disk, and recreated as +an export. Prior to v3.2.3, exports would wipe the uSyncActions.config file as part of this process, but we found this could cause problems as the target systems then -didn't know about any deletes that might have happened previously. +wouldn't know about any deletes that might have happened previously. -in v3.2.3 we have introduced an option to keep or delete the action file on a full +In v3.2.3 we have introduced an option to keep or delete the action file on a full export. It is now recommended that you keep the action file on a full export, as this will -at least make sure that all downstream installs of umbraco will at least know of +make sure that all downstream installs of Umbraco will at least know of any deletes. You will only want to delete the action file once you are sure that all possible -orphaned items have been removed from all of your umbraco instanced. +orphaned items have been removed from all of your Umbraco instances. diff --git a/docs/backoffice-config.md b/docs/backoffice-config.md index 78fea3b0..70fb8ae6 100644 --- a/docs/backoffice-config.md +++ b/docs/backoffice-config.md @@ -7,30 +7,30 @@ The ```uSyncBackOffice.Config``` file controls the basic behaviour of uSync ### Folder ```~/uSync/data``` -Defines where uSync should store it's files +Defines where uSync should store its files ### Import ```true``` -Turns import at startup on or off. if this is false uSync will not import when +Turns import at startup on or off. If this is ```false``` uSync will not import when the site starts ### ExportAtStartup ```false``` -Tells usync to run an export when the site starts, usally false +Tells uSync to run an export when the site starts, usually ```false```. ### ExportOnSave ```true``` -Export when you save (or delete) and item within Umbraco. +Export when you save (or delete) an item within Umbraco. -With this set to true - everything on teh disk will automatically stay in sync with +With this set to ```true``` - everything on the disk will automatically stay in sync with the database. ### Watch For Changes ```false``` -Have uSync watch the disk for any changes in files in the usync folder. +Have uSync watch the disk for any changes in files in the uSync folder. If you copy or save new .config files into the uSync folder - then uSync will -run a import against the folder, to get any new changes. +run an import against the folder, to get any new changes. ### Archiving ```xml @@ -38,20 +38,20 @@ run a import against the folder, to get any new changes. ~/uSync/Archive/ 0 ``` -usally when you make a change usync saves that change over the top of any existing -ones. this is fine if you are using source control to manage your site, but if you -want you can get uSync to make a back up of the existing files before it saves. +Usually when you make a change, uSync saves that change over the top of any existing +ones. This is fine as long as you are using source control to manage your site, but if you +want you can get uSync to create a backup of the existing files before it saves. ### Don't Throw Errors ```false``` -Some times things go wrong, and when they do uSync usally notices them, but -occasionally something can go really wrong and uSync throws an error, and you +Sometimes things go wrong and when they do uSync usually notices them, but +occasionally something can go really wrong and uSync throws an error and you get a YSOD. This can be really bad on a live site, because on startup uSync will throw a YSOD -and you will not get a site. +and your site will not load. -To avoid this you can have uSync catch that last exception, and not throw the YSOD. -this means you get your site. but it also means you won't see if uSync has gone wrong +To avoid this, you can have uSync catch that last exception, and not throw the YSOD. +This means you get your site, but it also means you won't see if uSync has gone wrong unless you go looking in the logs. ## Example Config @@ -78,13 +78,13 @@ unless you go looking in the logs. false + if you're using source control, you probably don't want this --> false ~/uSync/Archive/ 0 + help, when rollback is implemented --> ~/uSync/Backup/ diff --git a/docs/contentedition.md b/docs/contentedition.md index 545360d3..74242e31 100644 --- a/docs/contentedition.md +++ b/docs/contentedition.md @@ -1,6 +1,6 @@ # uSync Content Edition -By default uSync concentrates on the developer and setting elements of Umbraco, +By default, uSync concentrates on the developer and setting elements of Umbraco, but **uSync.ContentEdition** expands that to also include Content and Media ```bash @@ -8,7 +8,7 @@ PM>Install-Package uSync.ContentEdition ``` At its heart uSync.ContentEdition is really just two new uSync Handlers, that get added to the -core uSync.BackOffice tool. Once installed these two Handlers all called just like all the +core uSync.BackOffice tool. Once installed these two Handlers are called just like all the other handlers but they manage content and media items. # Content @@ -16,21 +16,21 @@ Content is stored in the ```uSync/data/content``` folder, and is a file based re of the content stored inside Umbraco. # Media -By default uSync stores the media settings, in the ```uSync/data/media``` as of later versions (3.2+) -it does not also store a copy of the media items. Since Umbraco 7.4 it has become much easier to -just copy your media folder between installations, and let uSync just deal with the media config. +By default, uSync stores the media settings, in the ```uSync/data/media```. As of later versions (3.2+) +it does not store a copy of the media items anymore. Since Umbraco 7.4 it has become much easier to +just copy your media folder between installations, and let uSync only deal with the media config. ## Mappers -The biggest trick to moving media and content between umbraco installations is mapping the internal -ids between installations. By default Umbraco uses Interger based Ids when linking items. The value -of these ids can change between umbraco instances - so when content is moved they need to be mapped. +The biggest trick to moving media and content between Umbraco installations is mapping the internal +IDs between installations. By default, Umbraco uses integer based IDs when linking items. The value +of these IDs can change between Umbraco instances - so when content is moved they need to be re-mapped. -For the most part we can now do this by converting them to the umbraco Key (GUID) values, and making -sure we set thesse keys the same on all instances - the inclusion of these Key values in Umbraco -(Increasingly since v7.3) has made that element of mapping much more successfull. +For the most part we can now do this by converting them to the Umbraco Key (GUID) values, and making +sure, we set these keys the same on all instances - the inclusion of these Key values in Umbraco +(Increasingly since v7.3) has made that element of mapping much more successful. -the second part of mapping is finding the Ids to map. Content is often made up of many diffrent +the second part of mapping is finding the Ids to map. Content is often made up of many different properties all with their own special data types that store the content in their own special way. For each of these types uSync needs to know 1) that they store IDs and 2) the format they do it in. @@ -49,7 +49,7 @@ Content Mappers handle this for uSync.ContentEdition. and out of the box uSync c * Dropdown List * Dropdown ListPublishing keys * Dropdown List Multiple Publishing keys -* Dropdwon Multiple +* Dropdown Multiple * CheckBoxList * Umbraco Grid. @@ -58,9 +58,9 @@ Content Mappers handle this for uSync.ContentEdition. and out of the box uSync c We also include third party mappers -**Thirdpart Mappers** +**Third-party Mappers** -* Archeype +* Archetype * Nested Content * Vorto * DocTypeGridEditor @@ -69,5 +69,5 @@ We also include third party mappers * CTH. Extended Media Picker #### Roll your own mappers -You can also write your own Content Mappers, you need to impliment the +You can also write your own Content Mappers, you need to implement the [IContentMapper](https://github.com/KevinJump/uSync/blob/Dev-v7_4/Jumoo.uSync.Core/Mappers/IContentMapper.cs) interface diff --git a/docs/core-config.md b/docs/core-config.md index 01a0704b..4c84141d 100644 --- a/docs/core-config.md +++ b/docs/core-config.md @@ -1,29 +1,29 @@ # uSync.Core uSync is split into two elements Core and BackOffice. Core actually does -the serialization/deserlization of items to and from Umbraco. +the serialization/de-serialization of items to and from Umbraco. -The Core doesn't do anything on teh disk or with events - it has been +The Core doesn't do anything on the disk or with events - it has been developed this way so that the Core can be used for other ways of Syncing -things, for example in your own code or via webservices or the command line. +things, for example in your own code or via web services or the command line. ## uSyncCore.Config -The uSyncCore.Config file controls the settings for the serilzation/deserlization of -things from umbraco. +The uSyncCore.Config file controls the settings for the serialization/de-serialization of +things from Umbraco. ## Media -Almost everything uSync.Core does is in memeory, except for when you are syncing Media items -then uSync can export them values to disk. +Almost everything uSync.Core does is in memory, except for when you are syncing Media items +then uSync can export those values to disk. -since Umbraco 7.4 the way the ID of the media folder was created has moved from the database to +Since Umbraco 7.4 the way the ID of the media folder was created has moved from the database to disk (at startup Umbraco now just looks for the highest number folder and carries on from there.) -because of this it is now recommended that you don't get uSync to copy your media folder - rather +Because of this it is now recommended that you don't get uSync to copy your media folder - rather you just copy the actual media folder between sites. **uSync will still sync the media settings, and you will need have uSync keep these settings in sync.** but you don't want uSync also -creating copies of all your media and giving you a massive disk headace. +creating copies of all your media and giving you a massive disk headache. If you do want uSync to manage the media outside of the media folder use the following settings. @@ -33,18 +33,17 @@ If you do want uSync to manage the media outside of the media folder use the fol ``` ## Mappings -Inside Umbraco a lot of information is stored against the item Id which is an Int value, that can +Inside Umbraco a lot of information is stored against the item ID which is an Int value, that can change between installations. -When you move configuration or items between umbraco installations, we need to map these id values -so they still make sense on the other side. The mappings section of the config sets up these mappings inside datatypes/doctypes. +When you move configuration or items between Umbraco installations, we need to map these ID values, so they still make sense on the other side. The mappings section of the config sets up these mappings inside datatypes/doctypes. An example of this is the MultiNodeTreePicker (MNTP) -When you select a root node for your MNTP in umbraco the value of the content node is stored as an Interger -inside umbraco. +When you select a root node for your MNTP in Umbraco the value of the content node is stored as an Integer +inside Umbraco. -The follwing config tells uSyncCore how to map this value. +The following config tells uSyncCore how to map this value. ```xml @@ -59,13 +58,13 @@ The follwing config tells uSyncCore how to map this value. ## Content Mappings Content Mappings are just like mapping except they work inside Content and Media items. -The storage of IDs inside Media and Content is way more common, and happens everyime you put a link +The storage of IDs inside Media and Content is way more common, and happens every time you put a link in your content, or pick an image or a node. -the Content mappers handle these mappings, and uSync comes with all the mappings needed for the common +The Content mappers handle these mappings, and uSync comes with all the mappings needed for the common datatypes. -uSync Content Edition - also includes mappings for many third party packages including : +uSync Content Edition - also includes mappings for many third-party packages including: * Archetype * Vorto @@ -75,7 +74,7 @@ uSync Content Edition - also includes mappings for many third party packages inc These mappings work on standard content, in nested content and in the grid. -Content Mappers are reasonably simple to impliment if you know the structure of the content inside -umbraco. and the best way to see how they are implimented is to look at the code for +Content Mappers are reasonably simple to implement if you know the structure of the content inside +Umbraco. and the best way to see how they are implemented is to look at the code for [Jumoo.uSync.ContentMappers](https://github.com/KevinJump/uSync/tree/Dev-v7_4/Jumoo.uSync.ContentMappers) - \ No newline at end of file + diff --git a/docs/getting-started.md b/docs/getting-started.md index 65455855..c64fb80c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,8 +4,8 @@ At the basic level, uSync 'just works' out of the box. ## First Run -The first time you run your umbraco site after installing uSync. uSync will -perform a export of your settings from the site. +The first time you run your Umbraco site after installing uSync. uSync will +perform an export of your settings from the site. **uSync will export:** @@ -18,27 +18,27 @@ perform a export of your settings from the site. - Dictionary Items - Member Types *(disabled by default)* -the export will be put in the ```uSync/data``` folder within your umbraco site. +the export will be placed in the ```uSync/data``` folder within your Umbraco site. ## Export On Save / Delete -Once usync is running it will listen for events related to saving or deleting -of items within umbraco. +Once uSync is running it will listen for events related to saving or deleting +of items within Umbraco. Every time you save and item uSync will write out an export file for the item in the uSync/data folder. -When you delete an item - a entry is made into the ```uSyncActions.config``` file -that tracks deletes. this file is used during an import, to process the delete -on other umbraco instances. +When you delete an item - an entry is made into the ```uSyncActions.config``` file +that tracks deletes. This file is used during an import, to process the delete +on other Umbraco instances. ## Import On Startup -by default uSync will run an import everytime your umbraco site starts (or the +By default, uSync will run an import every time your Umbraco site starts (or the application pool refreshes). -During an import uSync looks at the files in teh uSync/data folder and compares -them with the items within the umbraco site. +During an import uSync looks at the files in the uSync/data folder and compares +them with the items within the Umbraco site. -If there are any diffrences then uSync applies the values from disk to Umbraco, +If there are any differences then uSync applies the values from disk to Umbraco, so this way things are kept in sync. ## uSync Dashboard diff --git a/docs/handler-config.md b/docs/handler-config.md index ea41000a..9ef310fe 100644 --- a/docs/handler-config.md +++ b/docs/handler-config.md @@ -1,9 +1,9 @@ ## Handlers -Handlers are the thing that do all the hardwork in uSync. A Handler manages the import, +Handlers are the things that do all the hard work in uSync. A Handler manages the import, export and saving of items to and from Umbraco. -by default there are handlers for all the things in umbraco: +By default, there are handlers for all the things in Umbraco: ```xml @@ -23,21 +23,21 @@ by default there are handlers for all the things in umbraco: exists on disk but isn't in the config it will be enabled by default ### Enabling Handlers -turning a handler on or off is as simple as setting ```Enabled="false"``` in the config +Turning a handler on or off is as simple as setting ```Enabled="true"``` or ```Enabled="false"``` in the config. ### Enabling for actions In uSync 3.2.2. you can now enable or disable handlers for each of the actions they -perfom. +perform. -by default handlers manage **import**, **export** and save **events** for each type of items. +By default, handlers manage **import**, **export** and **save** events for each type of items. -you can now turn each of these on/off individually using the Actions="" attrribute +You can now turn each of these on/off individually using the ```Actions=""``` attribute. -```Actions="All"``` is the default , meaning a handler does all three things. +```Actions="All"``` is the default, meaning a handler does all three things. -possible settings are any combination of ```All,Import,Export,Events``` +Possible settings are: any combination of ```All,Import,Export,Events``` -for example if you want to have the DictionaryHandler only manage exports +for example, if you want to have the DictionaryHandler only manage exports ```xml diff --git a/docs/index.md b/docs/index.md index 426a75db..3c8ba1f2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,12 @@ # uSync -uSync is a database / file syncing tool for Umbraco. It makes source control, and +uSync is a database / file syncing tool for Umbraco. It makes source control and deployment easier, because you only have to worry about changes on the disk - and let uSync do all the database stuff. ## Getting uSync -The best way to get usync is via Nuget +The best way to get uSync is via Nuget ```bash PM>Install-Package uSync diff --git a/docs/install.md b/docs/install.md index e8706393..d91835e6 100644 --- a/docs/install.md +++ b/docs/install.md @@ -14,9 +14,9 @@ PM> Install-Package uSync ## Our Umbraco -To install from Our Umbraco, you can either download the pacakge from: +To install from Our Umbraco, you can either download the package from: > [https://our.umbraco.org/projects/developer-tools/usync/](https://our.umbraco.org/projects/developer-tools/usync/) -or install it via the package installer inside umbraco. +or install it via the package installer inside Umbraco. diff --git a/docs/usync-project.md b/docs/usync-project.md index 86e17392..df399823 100644 --- a/docs/usync-project.md +++ b/docs/usync-project.md @@ -1,13 +1,13 @@ # uSync Project -uSync is actually made up of a number of projects, each one doing it's own element of the +uSync is actually made up of a number of projects, each one doing its own element of the wider syncing process. ## uSync.Core -Core does all the serialization/deserizliation of elements to and from Umbraco. +Core does all the serialization/de-serialization of elements to and from Umbraco. Within the Core all the main mapping, and comparisons are performed - making sure that -items exported from umbraco can go into another installation and have things like +items exported from Umbraco can go into another installation and have things like links and content node pointers maintained. ## uSync.BackOffice @@ -15,24 +15,24 @@ links and content node pointers maintained. BackOffice is what most people think of as uSync. the BackOffice element handles the files on the disk, starts the imports and exports, passing each file to the Core -back office also manages the save and delete events - to capture changes as they are -made inside umbraco. +BackOffice also manages the save and delete events - to capture changes as they are +made inside Umbraco. ## uSync.ContentEdition -ContentEdtion is the addition of two new Mappers to uSync.BackOffice. one for Content +ContentEdition is the addition of two new Mappers to uSync.BackOffice. One for Content and one for Media. Content Edition also imports uSync.ContentMappers which has additional Content Mappers -that help with the translation of internal IDs between umbraco sites. +that help with the translation of internal IDs between Umbraco sites. ## uSync.Snapshots -Snapshots is a slightly diffrent way of working with uSync, instead of having uSync save +Snapshots is a slightly different way of working with uSync, instead of having uSync save all the changes all the time. Snapshots lets you create single point in time changesets of what is happing inside Umbraco. ## uSync.Chauffeur uSync.Chauffeur is a set of commands that can be added to Chauffeur, so you can run -uSync commands from the command line. \ No newline at end of file +uSync commands from the command line. diff --git a/docs/versions.md b/docs/versions.md index 01b39757..3a4f94ec 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -1,8 +1,7 @@ # uSync Versions -uSync uses quite a lot of the underling Api of Umbraco it is subseptible to changes -that otherwise make little diffrence to the user, but it does mean there are diffrent Versions -of uSync depending on what version of Umbraco you are using: +As uSync uses quite a lot of the underlying API of Umbraco, it is susceptible to changes +that otherwise make little difference to the user. Changes in the Umbraco API mean that there are different Versions of uSync depending on what version of Umbraco you are using: | Umbraco Version | uSync Version |--------------------|---------------------- @@ -18,11 +17,11 @@ of uSync depending on what version of Umbraco you are using: You should install the latest version for your version of Umbraco. # Upgrades -When you Upgrade Umbraco it is also recommended that you upgrade uSync. +When you Upgrade Umbraco, it is also recommended that you upgrade uSync. -once you have upgraded Umbraco and uSync you should remove your uSync +Once you have upgraded Umbraco and uSync you should remove your uSync folder and let uSync create a new sync. -While there is compatability between versions, the matching and change +While there is compatibility between versions, the matching and change detection is much more reliable and quicker when the uSync files are -from the latest versions of uSync. \ No newline at end of file +from the latest versions of uSync.