Merge pull request #327 from Code-dot-mil/add-oss-faq

Add oss faq

Author: risacher

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "AI4SDLC"]
 	path = AI4SDLC
 	url = https://github.com/Code-dot-mil/AI4SDLC
+[submodule "oss-faq"]
+	path = src/oss-faq
+	url = https://github.com/Code-dot-mil/oss-faq

CONTRIBUTORS.md

@@ -13,6 +13,7 @@
 - Copyright 2022 Ryan O'Neill elfmaster@arcana-research.io
 - Copyright 2023 Even Stensberg evenstensberg@gmail.com
 - Copyright 2024 David Saeger david@dds.mil
+- Copyright 2026 Daniel Risacher Daniel.R.Risacher.CIV@mail.mil
 - _Add the copyright date, your name, and email address here. (PLEASE KEEP THIS LINE)_
 
 ## Note for U.S. Federal Employees

_config.yml

@@ -5,6 +5,15 @@ include:
   - _headers
   - _redirects
 
+# The oss-faq submodule is a repository in its own right, so it carries files
+# that belong to the repository rather than to the published page. They have no
+# front matter, which means Jekyll would otherwise copy them into the site
+# verbatim. Only faq.md and its images and references should be published.
+exclude:
+  - oss-faq/README.md
+  - oss-faq/TODO.md
+  - oss-faq/LICENSE
+
 host: 0.0.0.0
 
 title: Code.mil

scripts/test

@@ -5,6 +5,14 @@ bundle exec jekyll build
 mkdocs build -f ai4sdlc-mkdocs.yml --site-dir public/AI4SDLC --quiet
 # Government and some other sites block automated requests with 403; ignore them.
 # code.mil self-references are canonical/sitemap links generated by MkDocs; ignore them too.
+#
+# The OSS FAQ is excluded for the same reason AI4SDLC is: it is maintained in
+# its own repository and link-checked there. It carries roughly 205 links across
+# some 60 .mil and .gov hosts, many of which reject non-browser user agents,
+# sit behind CAC/PKI, or return soft 404s -- a 200 with an empty body. Checking
+# it usefully needs a realistic user agent and content inspection rather than
+# status codes alone, which is more than this site-wide sweep is set up to do.
+# The pattern matches both the page (/oss-faq.html) and its assets (/oss-faq/).
 bundle exec htmlproofer ./public --timeframe 6w \
-  --file-ignore "/\/AI4SDLC\//" \
+  --file-ignore "/\/AI4SDLC\//,/oss-faq/" \
   --url-ignore "/^mailto:/,/code\.mil\//,/code.gov\/about\/open-source\/introduction/,/code.gov\/about\/compliance\/inventory-code/,/twitter.com\/DefenseDigital/,/dodcio\.defense\.gov/,/www\.defense\.gov/,/media\.defense\.gov/,/www\.esd\.whs\.mil/,/platform\.openai\.com/,/fonts\.gstatic\.com/"

src/_data/navigation.yml

@@ -5,9 +5,11 @@ secondary: &secondary_navigation
     href: /getting-started.html
   - text: How to Open Source
     href: /how-to-open-source.html
-  - text: FAQs
-    href: /frequently-asked-questions.html
+  - text: Open Source Software FAQ
+    href: /oss-faq.html
   - text: AI4SDLC
     href: /AI4SDLC/
+  - text: About Code.mil
+    href: /about.html
 
 sidebar: *secondary_navigation

src/_data/tree_nodes.yml

@@ -74,7 +74,7 @@
       - modify the contract to require delivery by open source code repository; or
       - wait for delivery and open source the resulting code (this could be tricky).
 
-    There are a lot of possibilities within those options, however. We encourage you to read our [frequently asked questions](/frequently-asked-questions.html) and then reach out to us by email at [{{site.email}}](mailto:{{site.email}}) to continue the conversation.
+    There are a lot of possibilities within those options, however. We encourage you to read our [Open Source Software FAQ](/oss-faq.html) and then reach out to us by email at [{{site.email}}](mailto:{{site.email}}) to continue the conversation.
 
 - title: Gov Only
   id: gov-only
@@ -105,6 +105,6 @@
 - title: Not yet
   id: info-only
   content: |
-    That's great! We're glad you are interested in open source. You may want to start by reading our [Why Open Source](/why-open-source.html) page and some of the [Frequently Asked Questions](/frequently-asked-questions.html). You can also explore information on the OMB policy itself over on the [Code.gov](https://code.gov) website.
+    That's great! We're glad you are interested in open source. You may want to start by reading our [Why Open Source](/why-open-source.html) page and some of the [Open Source Software FAQ](/oss-faq.html). You can also explore information on the OMB policy itself over on the [Code.gov](https://code.gov) website.
 
     If you would like to have a follow up conversation, feel free to reach out to us at [{{site.email}}](mailto:{{site.email}})

src/frequently-asked-questions.md src/about.mdsrc/frequently-asked-questions.md renamed to src/about.md

@@ -1,12 +1,12 @@
 ---
-title: Frequently Asked Questions (FAQs)
-updated_at: 2024-07-25
+title: About Code.mil
+updated_at: 2026-08-07
 
 sticky_sidenav: false
 
 subnav:
   - text: "What is Code.mil?"
-    href: "/frequently-asked-questions.html#what-is-codemil"
+    href: "/about.html#what-is-codemil"
 ---
 
 ## What is Code.mil?

src/assets/js/main.js

@@ -49,8 +49,13 @@
    * and the function below is where we do the work.
    */
   (function SubNav() {
-    if (/^\/frequently\-asked\-questions/.test(window.location.pathname)) {
-      insertSubNav('#main-content h2', '/frequently-asked-questions.html', 1);
+    if (/^\/about/.test(window.location.pathname)) {
+      insertSubNav('#main-content h2', '/about.html', 1);
+    } else if (/^\/oss\-faq/.test(window.location.pathname)) {
+      // Skips two headings rather than one: the FAQ opens with its own
+      // top-level heading, and the section after it is already seeded by the
+      // page's subnav front matter.
+      insertSubNav('#main-content h2', '/oss-faq.html', 2);
     } else if (/^\/how\-to\-open\-source/.test(window.location.pathname)) {
       insertSubNav('#main-content h3', '/how-to-open-source.html', 1);
     }

src/frequently-asked-questions.html

@@ -0,0 +1,23 @@
+---
+layout: null
+permalink: /frequently-asked-questions.html
+---
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>Redirecting to About Code.mil</title>
+  <meta http-equiv="refresh" content="0; url=/about.html">
+  <link rel="canonical" href="/about.html">
+</head>
+<body>
+  <p>
+    This page is now <a href="/about.html">About Code.mil</a>. If you are not
+    redirected automatically, follow that link.
+  </p>
+  <p>
+    Looking for the Department of War Open Source Software FAQ? That is at
+    <a href="/oss-faq.html">/oss-faq.html</a>.
+  </p>
+</body>
+</html>