Skip to content

Commit

Permalink
♻️ Add links to wiki in ReadMe (#91)
Browse files Browse the repository at this point in the history
<!-- describe the change, why is it needed and what does it accomplish
as per https://ssw.com.au/rules/write-a-good-pull-request/ -->
Add the required documentation to the repo.

Fixes #37 

<!-- Add done video, screenshots as per
https://ssw.com.au/rules/record-a-quick-and-dirty-done-video/-->
<img width="898" alt="image"
src="https://github.com/SSWConsulting/SSW.Dory/assets/41951199/7bcb0b58-50d5-4373-b095-27ec5417a7ed">\
**Figure: SSW Dory repo readme**

<img width="1452" alt="image"
src="https://github.com/SSWConsulting/SSW.Dory/assets/41951199/53cb78e5-4303-4d32-9307-f9bb0de4d2ce">\
**Figure: SSW Dory website readme**

<!-- As per rule https://www.ssw.com.au/rules/over-the-shoulder-prs -->
<!-- Getting the PR merged is part of the task - Call someone to review
your changes to get them merged ASAP -->
  • Loading branch information
leahy268 authored Nov 17, 2023
2 parents bdad01d + 4d5b202 commit d9c5f9e
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Overview
SSW.Dory is a solution to keep track of SharePoint files that have been checked out or GitHub Pull Requests that have not been merged.
# SSW.Dory

![SSW-Dory-Banner](https://github.com/SSWConsulting/SSW.Dory/assets/41951199/7b70190d-d5d8-4088-b033-deaf081c0453)

SSW.Dory is a solution to keep track of SharePoint files that have been checked out or GitHub Pull Requests that have not been merged. The low-code solution can be found on [Microsoft Power Automate](https://github.com/SSWConsulting/SSW.Dory/wiki/Power-Automate-Flows). This repo holds the SSW.Dory website code in the [contents](https://github.com/SSWConsulting/SSW.Dory/tree/edit-readme-add-wiki/content) folder.

## See the Important Documents

- [Business](https://github.com/SSWConsulting/SSW.Dory/wiki/Business)
- [Technologies and Architecture](https://github.com/SSWConsulting/SSW.Dory/wiki/Technologies-and-Architecture)
- [Alternative Solutions Considered](https://github.com/SSWConsulting/SSW.Dory/wiki/Alternative-Solutions-Considered)
- [Definition of Done](https://github.com/SSWConsulting/SSW.Dory/wiki/Definition-of-Done)
- [Definition of Ready](https://github.com/SSWConsulting/SSW.Dory/wiki/Definition-of-Ready)
- [Power Automate Flows](https://github.com/SSWConsulting/SSW.Dory/wiki/Power-Automate-Flows)

## Architecture Diagram

Expand Down
13 changes: 12 additions & 1 deletion content/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
# SSW.Dory Landing Page
# SSW.Dory Website

## See the Important Documents

- [Instructions - Compile (F5 Experience)](https://github.com/SSWConsulting/SSW.Dory/wiki/Instructions-Compile-(F5-Experience))
- [Instructions - Deployment](https://github.com/SSWConsulting/SSW.Dory/wiki/Instructions-Deployment)

## Architecture Overview
![SSW Dory architecture diagram](../docs/images/dory-website-architecture-diagram.webp)

## Get Started

### Navigate to website code:

```bash
cd content
```

### Install the project's dependencies:

```bash
Expand Down

0 comments on commit d9c5f9e

Please sign in to comment.