chore(site): edit GitHub links from hyper contrib documents (#90)

isaaccloos · web-flow · commit 4023bce95979 · 2023-04-28T10:13:37.000-04:00
Populate a new page field 'hyper_path' for copied contrib files. Conditionally link back to hyper if a 'hyper_path' is present, otherwise continue to reference hyperium.github.io (relevant for all collections besides contrib). Closes hyperium/hyper#3210
diff --git a/.github/workflows/contrib.yml b/.github/workflows/contrib.yml
@@ -32,16 +32,25 @@ jobs:
           cp -a hyper/CONTRIBUTING.md hyper/docs/CONTRIBUTING.md
 
       # Insert frontmatter borders, replace markdown header with
-      # frontmatter title and insert layout: guide
+      # frontmatter title and insert: 
+      #   - layout: guide
+      #   - hyper_path: {path}
       - name: Convert doc titles to frontmatter 
         run: |
           for f in hyper/docs/*.md; do
             sed -i -e '1i ---' \
             -e '1s/#/title:/' \
             -e '2i layout: guide' \
+            -e "2i hyper_path: ${f:6}" \
             -e '2i ---' $f;
           done
 
+      # CONTRIBUTING.md is uniquely copied into the docs folder.
+      # This adjustment links the correct source file.
+      - name: Retain correct CONTRIBUTING.md path
+        run: |
+          sed -i -e '4s/docs\//github.com/' hyper/docs/CONTRIBUTING.md
+
       # Use the hyper docs readme as the index page of contrib,
       # and insert permalink: /contrib/ in the frontmatter
       - name: Convert readme to index
@@ -71,8 +80,8 @@ jobs:
                 continue
               fi
 
-              # lowercase filenames
-              sed -i -e "s|${filename}|${filename,,}|g" $file;
+              # lowercase filenames outside frontmatter
+              sed -i -e "1,/^---$/!s|${filename}|${filename,,}|g" $file;
 
               # match on the lowercased filename from here on
               lowercased=${filename,,}
diff --git a/_includes/footer.html b/_includes/footer.html
@@ -3,9 +3,15 @@
         <div class="row">
             <div class="col-sm-6 text-center text-sm-left text-muted">&copy; 2023 hyper</div>
             <div class="col-sm-6 text-center text-sm-right">
-                <a href="https://github.com/hyperium/hyperium.github.io/blob/master/{{ page.path }}">
-                    edit this page on github
-                </a>
+                {% if page.hyper_path %}
+                    <a href="https://github.com/hyperium/hyper/blob/master/{{ page.hyper_path }}">
+                        edit this page on github
+                    </a>
+                {% else %}
+                    <a href="https://github.com/hyperium/hyperium.github.io/blob/master/{{ page.path }}">
+                        edit this page on github
+                    </a>
+                {% endif %}
             </div>
         </div>
     </div>
