Skip to content

Commit

Permalink
Merge pull request #4 from solidify/feature/4289-docs
Browse files Browse the repository at this point in the history
Updated links
  • Loading branch information
MOlausson authored Mar 23, 2021
2 parents 6bc91e1 + bf31eae commit 9f1301a
Show file tree
Hide file tree
Showing 11 changed files with 31 additions and 33 deletions.
2 changes: 0 additions & 2 deletions docs/Administration/Configuration-and-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,3 @@ Press Save to trigger the configuration of @Scale. After a few seconds the Plann
# Customization

More info coming soon...

# Related articles
2 changes: 1 addition & 1 deletion docs/Administration/Data-storage-and-privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All data created by the @Scale extension is stored in the form of work items, me

All data created by the extension that could be considered additional or data created by the extension is also stored in the scope of the organization.

Apart from helping you manage data in backlog we also add additional work item types (such as objectives and risks) to your process as described in [Customization]() secton.
Apart from helping you manage data in backlog we also add additional work item types (such as objectives and risks) to your process as described in [Customization](/docs/Administration/Configuration-and-customization.md#customization) secton.

See the [@Scale - Privacy Policy](https://marketplace.visualstudio.com/items/solidify.solidify-scale/privacy) for more details.

Expand Down
2 changes: 1 addition & 1 deletion docs/Administration/Manage-licenses.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The @Scale extension is a licensed product and not sold. The license format is a subscription license where the Licensee can add and remove users based on needs. When a user gets added into the license pool a deduction will be made from the available number of licenses in the subscription.

@Scale licenses are separate from Azure DevOps licenses, where the purpose of the @Scale license is to control who gets access to the extension and in what role. See [Permissions]() for details on how the model works.
@Scale licenses are separate from Azure DevOps licenses, where the purpose of the @Scale license is to control who gets access to the extension and in what role. See [Permissions](/docs/Administration/Permissions.md) for details on how the model works.

# Request license

Expand Down
2 changes: 1 addition & 1 deletion docs/Administration/Subscription-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ If you want to change plan or discuss an Enterprise subscription, contact us at

## What happens after the trial?

When the trial expires you will no longer be able to access @Scale. Since we don't want to interfere with your data we will not remove anything when the subscription ends. Therefore to remove the data @Scale has added to your Azure DevOps environment you need to follow the instruction in [Uninstalling @Scale]().
When the trial expires you will no longer be able to access @Scale. Since we don't want to interfere with your data we will not remove anything when the subscription ends. Therefore to remove the data @Scale has added to your Azure DevOps environment you need to follow the instruction in [Uninstalling @Scale](/docs/Administration/Uninstalling-Scale.md).

# Subscription overview

Expand Down
18 changes: 9 additions & 9 deletions docs/Administration/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Administration guides

| **Topic** |
|---|
| [Subscription management](Subscription-management.md) |
| [Manage licenses](Manage-licenses.md) |
| [Permissions](Permissions.md) |
| [Configuration and customization](Configuration-and-customization.md) |
| [Installing on Azure DevOps Server](Installing-on-Azure-DevOps-Server.md) |
| [Data storage and privacy](Data-storage-and-privacy.md) |
| [Uninstalling @Scale](Uninstalling-Scale.md) |
| **Topic** | **Description** |
|---|---|
| [Subscription management](Subscription-management.md) | Understand how @Scale subscriptions work |
| [Manage licenses](Manage-licenses.md) | How to manage licenses for @Scale users |
| [Permissions](Permissions.md) | @Scale uses custom permissions to control who's allowed to do what |
| [Configuration and customization](Configuration-and-customization.md) | Details on how to configure your project for @Scale |
| [Installing on Azure DevOps Server](Installing-on-Azure-DevOps-Server.md) | If you want to run @Scale on Azure DevOps Server (on-premise) |
| [Data storage and privacy](Data-storage-and-privacy.md) | What information is handled by @Scale and how |
| [Uninstalling @Scale](Uninstalling-Scale.md) | Details on how to uninstall @Scale |
8 changes: 4 additions & 4 deletions docs/Reference/Board.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Working together at scale requires increased visibility into what others are doi

# Managing the program board

The program board shows the planned work for your team grouped by team and iteration. Use the [mapping pane]() (1) to drag planned items to the board. You can also add new items directly on the board using the "+ New item" context menu (2).
The program board shows the planned work for your team grouped by team and iteration. Use the [mapping pane](#mapping-items-to-board) (1) to drag planned items to the board. You can also add new items directly on the board using the "+ New item" context menu (2).

Dependencies between items are show as read strings (3) or you can add explicit work items to represent the dependency (4). Another nice charm on the card is the objective icon (6) that is shown when a board item is associated with an objective.

Expand Down Expand Up @@ -43,9 +43,9 @@ If you want to remove a dependency between two cards either open one of the work
|---|---|
| ![image.png](/docs/.attachments/image-4e95335d-c334-4344-a917-3250b39f98fb.png) | Select active program increment |
| ![image.png](/docs/.attachments/image-58e02360-f706-4d54-b513-c95394e04ee9.png) | Refresh content on page |
| ![image.png](/docs/.attachments/image-4d4aeaa2-efb7-4e21-9cfc-854e997d03ce.png) | Settings: [Board](), [Exclusions](), [Fields](), [Styles]() |
| ![image.png](/docs/.attachments/image-4d4aeaa2-efb7-4e21-9cfc-854e997d03ce.png) | Settings: [Board](#board-settings), [Exclusions](#exclusions), [Fields](#fields), [Styles](#styles) |
| ![image.png](/docs/.attachments/image-00d419df-cc66-42a6-b982-52171260bf8a.png) | Filter |
| ![image.png](/docs/.attachments/image-d2b2e0d4-a38b-4635-af19-b7578759ef1c.png) | [Options]() |
| ![image.png](/docs/.attachments/image-d2b2e0d4-a38b-4635-af19-b7578759ef1c.png) | [Options](#options) |
| ![image.png](/docs/.attachments/image-9e9e362c-248f-49d9-a2b2-03962629a97c.png) | Enter or exit full screen mode |

## Board settings
Expand Down Expand Up @@ -104,4 +104,4 @@ The options menu lets you quickly access frequently used features.
|---|---|
| Show compact cards | Show card in full or compact layout. The compact mode is great if you want to get an overview of a large board |
| Show dependencies | Show or hide the dependency lines between cards |
| Side panel | Open side panel tool: [Mapping]() |
| Side panel | Open side panel tool: [Mapping](#mapping-items-to-board) |
4 changes: 2 additions & 2 deletions docs/Reference/Objectives.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Clicking the action menu (...) for an Objective shows the available commands for
| **Command** | **Function** |
|---|---|
| Edit objective | Edit the selected Objective |
| Add link | [Link board item to Objective]() |
| Add link | [Link board item to Objective](#link-board-item-to-objective) |
| Delete objective | Deletes the selected Objective work item |

## Linked board item commands
Expand All @@ -41,7 +41,7 @@ The link board item to objective dialog is used to associate an objective to one

| **Control** | **Function** |
|---|---|
| ![image.png](/docs/.attachments/image-4e95335d-c334-4344-a917-3250b39f98fb.png) | Select [active program increment]() |
| ![image.png](/docs/.attachments/image-4e95335d-c334-4344-a917-3250b39f98fb.png) | Select [active program increment](/docs/Reference/Active-program-increment.md) |
| ![image.png](/docs/.attachments/image-58e02360-f706-4d54-b513-c95394e04ee9.png) | Refresh content on page |
| ![image.png](/docs/.attachments/image-9e9e362c-248f-49d9-a2b2-03962629a97c.png) | Enter or exit full screen mode |

Expand Down
8 changes: 4 additions & 4 deletions docs/Reference/Planning.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Clicking the action menu (...) for an ART shows the available commands for the i

| **Command** | **Function** |
|---|---|
| Add new PI to ART | [Create a new PI and associate to the ART]() |
| Add existing PI to ART | [Associate an existing PI to the ART]() |
| Add new PI to ART | [Create a new PI and associate to the ART](#create-a-new-pi-and-associate-to-an-art) |
| Add existing PI to ART | [Associate an existing PI to the ART](#associate-an-existing-pi-to-an-art) |
| Edit ART | Edit the ART definition if you want to change the name or associated teams |
| Set ART team order | [Configure the order of the teams for an ART]() |
| Set ART team order | [Configure the order of the teams for an ART](#configure-the-order-of-the-teams-for-an-art) |
| Delete ART | Delete the selected ART. The ART work item is deleted but can be restored like other work items from the [Recycle bin](https://docs.microsoft.com/en-us/azure/devops/boards/backlogs/remove-delete-work-items?view=azure-devops#restore-or-destroy-work-items) |

### Create a new PI and associate to an ART
Expand Down Expand Up @@ -65,7 +65,7 @@ Clicking the action menu (...) for a PI shows the available commands for the ite
| **Control** | **Function** |
|---|---|
| ![image.png](/docs/.attachments/image-58e02360-f706-4d54-b513-c95394e04ee9.png) | Refresh content on page |
| ![image.png](/docs/.attachments/image-4d4aeaa2-efb7-4e21-9cfc-854e997d03ce.png) | Settings: [Sprints]() |
| ![image.png](/docs/.attachments/image-4d4aeaa2-efb7-4e21-9cfc-854e997d03ce.png) | Settings: [Sprints](#sprints-configuration) |
| ![image.png](/docs/.attachments/image-9e9e362c-248f-49d9-a2b2-03962629a97c.png) | Enter or exit full screen mode |

## Sprints configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/Risks.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ When you have identify a risk you can quickly add it to the board using the "+ n
|---|---|
| ![image.png](/docs/.attachments/image-4e95335d-c334-4344-a917-3250b39f98fb.png) | Select active program increment |
| ![image.png](/docs/.attachments/image-58e02360-f706-4d54-b513-c95394e04ee9.png) | Refresh content on page |
| ![image.png](/docs/.attachments/image-4d4aeaa2-efb7-4e21-9cfc-854e997d03ce.png) | Settings: [Fields]() |
| ![image.png](/docs/.attachments/image-4d4aeaa2-efb7-4e21-9cfc-854e997d03ce.png) | Settings: [Fields](#fields-settings) |
| ![image.png](/docs/.attachments/image-9e9e362c-248f-49d9-a2b2-03962629a97c.png) | Enter or exit full screen mode |

## Fields settings
Expand Down
14 changes: 7 additions & 7 deletions docs/Reference/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# User guides

| **Topic** |
|---|
| [Planning](Planning.md) |
| [Objectives](Objectives.md) |
| [Risks](Risks.md) |
| [Board](Board.md) |
| [Analytics](Analytics.md) |
| **Topic** | **Description** |
|---|---|
| [Planning](Planning.md) | Plan your teams and increments |
| [Objectives](Objectives.md) | Define and track objectives and results |
| [Risks](Risks.md) | Manage project risks |
| [Board](Board.md) | Use a program board to plan and visualize work and dependencies |
| [Analytics](Analytics.md) | Track performance of your ARTs and teams |
2 changes: 1 addition & 1 deletion docs/Troubleshooting-and-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Beyond using [Discussions](https://github.com/solidify/scale/discussions) you ca
Reach out to your assigned contact for priority support.

# Bugs or product enchantment requests
Bugs and product enhancements can be submitted to the [Issues](https://github.com/solidify/scale/issues) for @Scale.
Bugs and product enhancements can be submitted as [Issues](https://github.com/solidify/scale/issues) for @Scale.

# Extended support
Solidify offers extended support where customers with valid licenses can get assistance with practices related to @Scale, such as SAFe practices, Azure DevOps as well as how to best integrate @Scale into existing workflows.
Expand Down

0 comments on commit 9f1301a

Please sign in to comment.