Skip to content

Update evidence-source location examples to include index.json #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Malcolmnixon merged 4 commits into from
Mar 11, 2026
Merged

Update evidence-source location examples to include index.json #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ce7de35
Initial plan
Copilot Mar 11, 2026
68a3c12
Update evidence-source examples to include index.json in location
Copilot Mar 11, 2026
b8de7ab
Update THEORY-OF-OPERATIONS.md
Malcolmnixon Mar 11, 2026
425a392
Fix MD013 line-length lint error in THEORY-OF-OPERATIONS.md
Copilot Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ needs-review:

evidence-source:
type: url # 'url' or 'fileshare'
location: https://reviews.example.com/evidence/
location: https://reviews.example.com/evidence/index.json

reviews:
- id: Core-Logic
Expand Down
8 changes: 4 additions & 4 deletions THEORY-OF-OPERATIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ needs-review:

evidence-source:
type: url # 'url' or 'fileshare'
location: https://reviews.example.com/evidence/
location: https://reviews.example.com/evidence/index.json

reviews:
- id: Core-Logic
Expand Down Expand Up @@ -70,8 +70,8 @@ ReviewMark queries the configured evidence source for review PDFs. Two source ty

| Type | Description |
| :--- | :---------- |
| `url` | HTTP/HTTPS endpoint; credentials supplied via environment variables |
| `fileshare` | UNC or local file-system path; credentials supplied via environment variables |
| `url` | Full HTTP/HTTPS URL to `index.json`; credentials supplied via environment variables |
| `fileshare` | Full UNC or local file-system path to `index.json`; access uses OS/share permissions |

#### Evidence Index

Expand Down Expand Up @@ -184,7 +184,7 @@ source:
```yaml
evidence-source:
type: url
location: https://reviews.example.com/evidence/
location: https://reviews.example.com/evidence/index.json
credentials:
username-env: REVIEWMARK_USER
password-env: REVIEWMARK_TOKEN
Expand Down
20 changes: 10 additions & 10 deletions docs/guide/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ needs-review:
# Where to find the evidence index (index.json).
evidence-source:
type: fileshare
location: \\reviews.example.com\evidence\
location: \\reviews.example.com\evidence\index.json

# Review sets: groups of related files reviewed together.
reviews:
Expand Down Expand Up @@ -307,25 +307,25 @@ completed review PDFs.

### Source Types

| Type | Description |
| :----------- | :---------------------------------------------- |
| `fileshare` | UNC path or local directory |
| `url` | HTTP or HTTPS endpoint |
| Type | Description |
| :----------- | :------------------------------------------------------ |
| `fileshare` | Full UNC or local file-system path to `index.json` |
| `url` | Full HTTP or HTTPS URL to `index.json` |

#### File Share

```yaml
evidence-source:
type: fileshare
location: \\reviews.example.com\evidence\
location: \\reviews.example.com\evidence\index.json
```

#### URL

```yaml
evidence-source:
type: url
location: https://reviews.example.com/evidence/
location: https://reviews.example.com/evidence/index.json
```

### Credentials
Expand All @@ -336,7 +336,7 @@ are never stored in the definition file or source control:
```yaml
evidence-source:
type: url
location: https://reviews.example.com/evidence/
location: https://reviews.example.com/evidence/index.json
credentials:
username-env: REVIEWMARK_USER # name of the environment variable holding the username
password-env: REVIEWMARK_TOKEN # name of the environment variable holding the password
Expand Down Expand Up @@ -370,7 +370,7 @@ needs-review:

evidence-source:
type: fileshare
location: \\reviews.example.com\evidence\
location: \\reviews.example.com\evidence\index.json

reviews:
- id: core-module
Expand Down Expand Up @@ -507,7 +507,7 @@ needs-review:

evidence-source:
type: url
location: https://reviews.example.com/evidence/
location: https://reviews.example.com/evidence/index.json
credentials:
username-env: REVIEWMARK_USER
password-env: REVIEWMARK_TOKEN
Expand Down
Loading