Skip to content

Commit 26aeb4b

Browse files
committed
Updates to the readme, especially regarding the on-premise installation.
1 parent a6ecf88 commit 26aeb4b

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ If you want to build the vsix package yourself (also compare the [official Micro
5454

5555

5656
**Inspecting the vsix package:**
57-
If you want to inspect the contents of the vsix package e.g. for security purposes, it can be extracted using tools such as [7-zip](https://www.7-zip.org/).
57+
If you want to inspect the contents of the vsix package e.g. for security auditing purposes, it can be extracted using tools such as [7-zip](https://www.7-zip.org/).
5858
Note that the html and javascript files have been minimized and merged via [webpack](https://webpack.js.org/) to improve loading times.
5959
So I suggest to read the original source from the [GitHub repository](https://github.com/Sedeniono/ADO-History-Diff) instead.
6060
You can then build the vsix package yourself (`npm run build`, see above) and verify that the content of your manually produced vsix package is the same as in the released vsix package (from the marketplace or GitHub releases page).
@@ -81,16 +81,19 @@ Note: Changing the theme in Azure DevOps (light to dark or vice versa) might not
8181

8282
## Uploading the extension to Azure DevOps Server
8383

84-
See the [official Microsoft documentation](https://learn.microsoft.com/en-us/azure/devops/marketplace/install-extension?view=azure-devops-2022). In short, the steps are:
84+
See the [official Microsoft documentation](https://learn.microsoft.com/en-us/azure/devops/marketplace/install-extension?view=azure-devops-2022). In short, you have to options:
85+
1. Option 1: Direct installation from the marketplace.
86+
In the web interface of your Azure DevOps Server, go to `Collection Settings` → `Extensions` → `Browse marketplace` (in the top right corner) → search for "Sedenion.HistoryDiff" to find the extension and click on it → `Get it free` → select the target collection from the drop down list → hit `Install` → `Proceed to collection`.
87+
2. Option 2: Manual upload of the vsix package.
88+
1. Download the vsix package either from the [Microsoft marketplace](https://marketplace.visualstudio.com/items?itemName=Sedenion.HistoryDiff) or the [releases here on GitHub](https://github.com/Sedeniono/ADO-History-Diff/releases).
89+
Both host identical files.
90+
Then in the web interface of your Azure DevOps Server, go to `Collection Settings` → `Extensions` → `Browse local extensions` (in the top right corner) → scroll down and select `Manage extensions` → then `Upload extension` (top right corner).
8591

86-
1. Get the vsix package either from the [Microsoft marketplace](https://marketplace.visualstudio.com/items?itemName=Sedenion.HistoryDiff) or the [releases here on GitHub](https://github.com/Sedeniono/ADO-History-Diff/releases).
87-
Both host identical files.
88-
Then in the web interface of your Azure DevOps Server, go to `Collection Settings` → `Browse local extensions` (in the top right corner) → scroll down and select `Manage extensions` → then `Upload extension` (top right corner).
89-
90-
2. Afterwards, on the `Browse local extensions` page, the `History Diff` extension should have appeared. Click on it → `Get it free` → select the target collection from the drop down list → hit `Install` → `Proceed to collection`.
92+
2. Afterwards, on the `Browse local extensions` page, the `History Diff` extension should have appeared. Click on it → `Get it free` → select the target collection from the drop down list → hit `Install` → `Proceed to collection`.
93+
94+
9195
You need to do this once per collection.
92-
93-
3. Simply uploading the extension is not enough if you use the "On-premises XML" process model. See next chapters for more information.
96+
Also, simply uploading the extension is not enough if you use the "On-premises XML" process model. See the next chapters for more information.
9497

9598

9699

@@ -250,7 +253,7 @@ Apart from the import/export steps, the steps of modifying the actual XML file s
250253

251254
# Future ideas
252255
* Support more artifact links.
253-
* Fork and improve [htmldiff](https://www.npmjs.com/package/node-htmldiff) to highlight pure formatting changes.
256+
* Show pure formatting changes. Maybe fork and try to improve [htmldiff](https://www.npmjs.com/package/node-htmldiff). Or possibly better, use Wikipedia's [VisualDiff](https://www.mediawiki.org/wiki/Special:MyLanguage/visual_diffs) from the [VisualEditor](https://github.com/wikimedia/mediawiki-extensions-VisualEditor) (but has more dependencies). Or port [DaisyDiff](https://github.com/DaisyDiff/DaisyDiff).
254257
* Once [markdown is available in Azure DevOps work items](https://developercommunity.visualstudio.com/t/add-markdown-support-in-discussions/365826), support it.
255258
* Show only the context of a change in longer descriptions (optionally).
256259
* Localization

0 commit comments

Comments
 (0)