Skip to content

Commit

Permalink
Merge pull request #34 from Jumoo/dev/structure
Browse files Browse the repository at this point in the history
Dev/structure
  • Loading branch information
KevinJump committed Nov 7, 2023
2 parents cf2285c + ee62e09 commit fa49292
Show file tree
Hide file tree
Showing 7 changed files with 58 additions and 8 deletions.
9 changes: 1 addition & 8 deletions usync/01.uSync/00.install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,13 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="pm"
defaultValue="core"
values={[
{ label: 'Package Manager', value: 'pm', },
{ label: 'Dotnet', value: 'core', },
{ label: 'Package reference', value: 'ref' }
]
}>
<TabItem value="pm">

```cli
install-package uSync
```

</TabItem>
<TabItem value="core">

```cli
Expand Down
39 changes: 39 additions & 0 deletions usync/01.uSync/02.guides/08.history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: History
---

The History feature logs imports and exports, allowing you to keep track of every change added to your files.

### Navigating to the History Page

To find the History page, navigate to Settings, and then uSync. The History tab is in the top right corner of the uSync settings page.

![The History button on the uSync dashboard.](historyButton.png)


### What does it do?

History will show you what changes were made in recent imports/exports. It will also tell you how much was changed, who changed it, and when.

![History showing an import and an Export](importHistory.png)

The page will not display an import or export if there were no differences between versions.

You can use the clear button to clear the record of imports and exports.

### The More Detailed View

You can click on an import or export to see all the changes made in more detail.

![The more detailed history page for a full export](exportDetails.png)

This allows you to track individual differences in the individual files that were synced.

### Detailed Imported Changes

On an import you can track changes even more specifically.

![Detected changes page for an import.](DetailedChanges.png)

If you click on an import, and then click Details on a changed file, you can see *exactly* what was changed.

18 changes: 18 additions & 0 deletions usync/01.uSync/02.guides/09.Upgrading.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Upgrading uSync
---


You can upgrade uSync by entering `dotnet add package uSync` into the commandline, just like downloading it.


## Keep Your uSync Folder Up to Date
Occasionally an update in Umbraco or uSync functionality will cause us to make a change in the format/detail of the uSync `.config` files. When this happens, we will increment the 'format version' of the files and uSync will warn you that the files might be using an old version.

![Format warning](format-warning.png)

Within a major version and often between major versions the files will still be compatible but changes can lead to "false positives" when checking files.

:::tip
Checks are always faster then import operations, To minimize "false positives" in uSync when checking files, perform clean exports after you upgrade uSync minor versions (e.g 10.0 -> 10.1).
:::
Binary file added usync/01.uSync/02.guides/DetailedChanges.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added usync/01.uSync/02.guides/exportDetails.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added usync/01.uSync/02.guides/historyButton.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added usync/01.uSync/02.guides/importHistory.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fa49292

Please sign in to comment.