Skip to content

Commit 5974022

Browse files
docs: changed external to linked and add emoji to visually differentiate on side navbar
1 parent 1d5a201 commit 5974022

8 files changed

Lines changed: 31 additions & 22 deletions

File tree

.github/workflows/pages.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ jobs:
3333
id: pages
3434
uses: actions/configure-pages@v5
3535

36-
- name: Import external docs
36+
- name: Import remote repository docs
3737
run: bash scripts/import_sources.sh
3838

39-
- name: Generate external project stubs
40-
run: python3 scripts/generate_external_redirects.py
39+
- name: Generate linked project stubs
40+
run: python3 scripts/generate_linked_redirects.py
4141

4242
- name: Build with Jekyll
4343
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"

_pages/projects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ has_children: true
1010

1111
The FEAST ecosystem consists of several project repositories that provide tools, resources, and implementations in support of our broader automation framework. Projects rendered directly on this site are accessible through the left-hand navigation menu.
1212

13-
Additional project pages, hosted externally, can be accessed via their corresponding GitHub Pages sites:
13+
Additional project pages, hosted standalone, can be accessed via their corresponding GitHub Pages sites:
1414

1515
- [Slice_TEMP](/Slice_TEMP/)
1616
- [Slice_DCMT](/Slice_DCMT/)

projects/external.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

projects/linked.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: page
3+
title: "Linked Projects   🔗"
4+
permalink: /projects/linked/
5+
parent: Projects
6+
has_children: true
7+
nav_order: 2
8+
---
9+
10+
The following linked projects are rendered in their own GitHub Pages sites but are listed here for navigation purposes.

projects/project1.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
layout: page
3+
title: "Project Alpha"
4+
permalink: /projects/project1/
5+
parent: Projects
6+
nav_order: 3
7+
---
8+
9+
Test
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
#!/usr/bin/env python3
22
"""
3-
Generate redirect stub pages for external projects.
4-
Each page redirects to a GitHub Pages site and is nested under 'Projects > External Projects'.
3+
Generate redirect stub pages for linked projects.
4+
Each page redirects to a GitHub Pages site and is nested under 'Projects > Linked Projects'.
55
"""
66

77
import json
88
from pathlib import Path
99

10-
CONFIG = Path("sources.external.json")
11-
OUT_DIR = Path("docs/projects/external")
10+
CONFIG = Path("sources.linked.json")
11+
OUT_DIR = Path("docs/projects/linked")
1212

1313

1414
def main():
1515
with CONFIG.open("r", encoding="utf-8") as f:
1616
data = json.load(f)
1717

18-
projects = data.get("external_projects", [])
18+
projects = data.get("linked_projects", [])
1919
OUT_DIR.mkdir(parents=True, exist_ok=True)
2020

2121
for i, proj in enumerate(projects, 1):
@@ -27,7 +27,7 @@ def main():
2727
content = f"""---
2828
layout: redirect
2929
title: {title}
30-
parent: External Projects
30+
parent: Linked Projects
3131
grand_parent: Projects
3232
nav_order: {i}
3333
redirect_to: {url}

scripts/import_sources.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22
# scripts/import_sources.sh
33
# -----------------------------------------------------------------------------
4-
# Import external docs into the hub repo.
4+
# Import remote repository docs into the hub repo.
55
#
66
# Behavior (idempotent):
77
# - For each entry in sources.json:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"external_projects": [
2+
"linked_projects": [
33
{
44
"name": "Slice_TEMP",
55
"title": "Slice TEMP",

0 commit comments

Comments
 (0)