Skip to content

Commit aee6249

Browse files
authored
Update AdoPipelineViewReadme.md
1 parent 1f61513 commit aee6249

File tree

1 file changed

+59
-13
lines changed

1 file changed

+59
-13
lines changed

AdoPipelineViewReadme.md

Lines changed: 59 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# 🔧 Deployment Notes: AdoPipelineView SPA and Blog Integration
1+
# 🔧 Deployment Notes: AdoPipelineView and other Single page app (SPA) and Blog Integration Details
22

33
## 🧠 Context
44

5-
This repository is part of a two-repo setup used to host:
5+
The FoxDeploy blog is part of a multi-repo setup used to host:
66

77
- 📰 A **Jekyll-based blog** at **https://www.foxdeploy.com/**
8-
- ⚙️ A **standalone Single Page App (SPA)** at **https://www.foxdeploy.com/AdoPipelineView/**
8+
- ⚙️ Some **standalone Single Page Applications (SPA)** at:
9+
- - **https://www.foxdeploy.com/AdoPipelineView/**
10+
- - **https://www.foxdeploy.com/ArmJsonOsTargetingConditionParser/**
911

1012
The SPA and blog are hosted via **GitHub Pages**, but they live in **separate repositories** for clarity and cleaner dev workflows.
1113

@@ -17,6 +19,7 @@ The SPA and blog are hosted via **GitHub Pages**, but they live in **separate re
1719
|-----|---------|-------------|
1820
| `https://www.foxdeploy.com/` | Main Jekyll blog | [`1redone.github.io`](https://github.com/1RedOne/1redone.github.io) |
1921
| `https://www.foxdeploy.com/AdoPipelineView/` | Deployed SPA | [`AdoPipelineView`](https://github.com/1RedOne/AdoPipelineView) |
22+
| `https://www.foxdeploy.com/ArmJsonOsTargetingConditionParser/` | Deployed SPA | [`OS Condition Targeting Parser`](https://github.com/1RedOne/ArmJsonOsTargetingConditionParser/tree/main) |
2023

2124
---
2225

@@ -25,30 +28,72 @@ The SPA and blog are hosted via **GitHub Pages**, but they live in **separate re
2528
The SPA source code is **NOT inside the blog repo** (`1redone.github.io`) — instead, it is located in its own repository:
2629

2730
> [`1RedOne/AdoPipelineView`](https://github.com/1RedOne/AdoPipelineView)
31+
> [`1RedOne/ArmJsonParser`](https://github.com/1RedOne/ArmJsonOsTargetingConditionParser)
2832
29-
This repo builds a single-page app (`index.html`, etc.) and publishes it to GitHub Pages using either:
30-
31-
- The `gh-pages` branch (recommended), OR
32-
- The `/docs` folder, OR
33-
- GitHub Actions with Pages deployment (e.g., `pages-build-deployment`)
33+
This repo builds a single-page app (`index.html`, etc.) and publishes it to GitHub Pages using the classic GitHub pages *DeployFromBranch* model, deploying from the `main` or `master` branches.
3434

3535
You can confirm it is published successfully at:
3636

3737
>https://github.com/1RedOne/AdoPipelineView/settings/pages
38-
38+
>https://github.com/1RedOne/ArmJsonOsTargetingConditionParser/deployments/github-pages
3939
4040
---
4141

42-
## 🔍 Why is this split across two repos?
42+
## 🔍 Why is this split across multiple repos?
43+
44+
Keeping the SPA separate helps because the main repo for the blog is already bound to the root of the FoxDeploy.com domain name.
45+
46+
These additional repos automatically inherit the FoxDeploy.com domain name when Pages are enabled, allowing their repo name to handle routing. Some other benefits are :
4347

44-
Keeping the SPA separate helps with:
45-
- Clean dev workflows (the SPA can use its own toolchain, like React, Vue, or Vite)
4648
- Independent deployments (no interference with Jekyll builds)
4749
- Smaller repos, faster CI
4850
- Easier separation of concerns
4951

5052
The blog can safely link to the SPA without needing to embed or bundle it.
5153

54+
#### Traffic Flow Chart
55+
```mermaid
56+
flowchart TD
57+
%% Main Flow
58+
A[User types<br>FoxDeploy.com] --> B[GoDaddy DNS/Hosting]
59+
B -->|Redirects to| C[GitHub Pages<br>1redone.github.io]
60+
61+
%% Root Blog
62+
C --> D[Root Repo: Blog]
63+
D -->|Served at| E[https://www.FoxDeploy.com/]
64+
E -->|Source of Truth| H[https://github.com/1RedOne/1redone.github.io]
65+
66+
%% Single Page Apps
67+
C --> F[GitHub Repos for SPAs]
68+
69+
F --> SPA1[FoxDeploy.com/<span style="color:red">AdoPipelineView</span>]
70+
SPA1 -->|Source of Truth| R1[https://github.com/1RedOne/AdoPipelineView]
71+
72+
F --> SPA2[FoxDeploy.com/<span style="color:red">JsonViewer</span>]
73+
SPA2 -->|Source of Truth| R2[https://github.com/1RedOne/JsonViewer]
74+
75+
%% Future SPA
76+
F --> FUTURE[FoxDeploy.com/<span style="color:red">RepoName</span>]
77+
FUTURE -->|Future Source of Truth| RFUTURE[https://github.com/1RedOne/RepoName]
78+
79+
%% Styling with black text forced
80+
style A fill:#f9f,stroke:#333,stroke-width:2px,color:#000
81+
style B fill:#ffd580,stroke:#333,stroke-width:2px,color:#000
82+
style C fill:#a0d2eb,stroke:#333,stroke-width:2px,color:#000
83+
style D fill:#c1e1c1,stroke:#333,stroke-width:2px,color:#000
84+
style E fill:#baffc9,stroke:#333,stroke-width:2px,color:#000
85+
style H fill:#baffc9,stroke:#333,stroke-width:2px,color:#000
86+
87+
style F fill:#fce2ce,stroke:#333,stroke-width:2px,color:#000
88+
style SPA1 fill:#fff2b2,stroke:#333,stroke-width:2px,color:#000
89+
style SPA2 fill:#fff2b2,stroke:#333,stroke-width:2px,color:#000
90+
style FUTURE fill:#f4c2c2,stroke:#333,stroke-width:2px,color:#000
91+
92+
style R1 fill:#cce5ff,stroke:#333,stroke-width:2px,color:#000
93+
style R2 fill:#cce5ff,stroke:#333,stroke-width:2px,color:#000
94+
style RFUTURE fill:#e0ccff,stroke:#333,stroke-width:2px,color:#000
95+
96+
```
5297

5398

5499
## 🧪 How to test changes to the SPA
@@ -111,6 +156,7 @@ Announce the new tool 🎉
111156

112157
Explain what it does
113158

159+
114160
Link to https://www.foxdeploy.com/CoolNewViewer/
115161

116-
Boom — you're done. Your new app is live, linked, and documented.
162+
Boom — you're done. Your new app is live, linked, and documented.

0 commit comments

Comments
 (0)