Publish the docs directory alongside the built site - #13
Merged
Conversation
Both deployment workflows (GitHub Pages and SharedServices) copy docs/ into _site/ right after the build, so repository documents like the SharedServices setup guide are served at /docs/ on each deployment — same content, same commit, on both the public and internal copies.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Both deployment workflows copy
docs/into_site/between the build and the artifact upload, so repository documents — currently the SharedServices setup guide — are served at/docs/on each deployment:pages.yml: merge step beforeupload-pages-artifact→ served athttps://codeforamerica.github.io/cfa-static/docs/sharedservices-deploy.yaml: merge step before the artifact upload → included in the S3 sync, so the guide will be on the internal copy at/docs/too (same content, same commit as the public deployment)Deliberately a workflow-level merge rather than an Eleventy passthrough: the guide is a repository document rather than site content, so it stays out of the local dev server, the site's block pipeline, and Pagefind scope — it would also quietly change the
_sitefixture expectations the test suite holds.Verification: both workflow YAMLs parse with the merge step present in each;
cp -r docs _site/semantics checked locally; precommit gate green.