From 9883958fff9f69cc10ab09eed67d1b4eaf4cd3bf Mon Sep 17 00:00:00 2001 From: James Person Date: Wed, 7 Feb 2024 16:19:04 -0500 Subject: [PATCH 01/79] New resource pages - initial commit --- .../resources/api/01-api-versioning.md | 6 +++ .../resources/api/02-developer-resources.md | 6 +++ .../api/03-interacting-with-the-api.md | 6 +++ .../audit_submission/01-submission-guide.md | 6 +++ .../02-federal-program-contacts.md | 6 +++ .../resources/audit_submission/03-SF-SAC.md | 6 +++ .../audit_submission/04-managing-access.md | 6 +++ .../audit_submission/05-burden-statement.md | 6 +++ .../resources/search/01-search-filters.md | 6 +++ .../resources/search/02-search-results.md | 6 +++ .../resources/search/03-tribal-audits.md | 6 +++ src/_includes/resources_page.njk | 44 +++++++++++++++++++ src/resources/api.md | 10 +++++ src/resources/audit-search.md | 10 +++++ src/resources/audit-submission.md | 10 +++++ src/scss/main.scss | 16 +++++-- 16 files changed, 152 insertions(+), 4 deletions(-) create mode 100644 src/_collections/resources/api/01-api-versioning.md create mode 100644 src/_collections/resources/api/02-developer-resources.md create mode 100644 src/_collections/resources/api/03-interacting-with-the-api.md create mode 100644 src/_collections/resources/audit_submission/01-submission-guide.md create mode 100644 src/_collections/resources/audit_submission/02-federal-program-contacts.md create mode 100644 src/_collections/resources/audit_submission/03-SF-SAC.md create mode 100644 src/_collections/resources/audit_submission/04-managing-access.md create mode 100644 src/_collections/resources/audit_submission/05-burden-statement.md create mode 100644 src/_collections/resources/search/01-search-filters.md create mode 100644 src/_collections/resources/search/02-search-results.md create mode 100644 src/_collections/resources/search/03-tribal-audits.md create mode 100644 src/_includes/resources_page.njk create mode 100644 src/resources/api.md create mode 100644 src/resources/audit-search.md create mode 100644 src/resources/audit-submission.md diff --git a/src/_collections/resources/api/01-api-versioning.md b/src/_collections/resources/api/01-api-versioning.md new file mode 100644 index 00000000..cf7d8c99 --- /dev/null +++ b/src/_collections/resources/api/01-api-versioning.md @@ -0,0 +1,6 @@ +--- +tags: resources, api +header: API versioning +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- \ No newline at end of file diff --git a/src/_collections/resources/api/02-developer-resources.md b/src/_collections/resources/api/02-developer-resources.md new file mode 100644 index 00000000..8a2edd57 --- /dev/null +++ b/src/_collections/resources/api/02-developer-resources.md @@ -0,0 +1,6 @@ +--- +tags: resources, api +header: Developer resources +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- \ No newline at end of file diff --git a/src/_collections/resources/api/03-interacting-with-the-api.md b/src/_collections/resources/api/03-interacting-with-the-api.md new file mode 100644 index 00000000..85d8de71 --- /dev/null +++ b/src/_collections/resources/api/03-interacting-with-the-api.md @@ -0,0 +1,6 @@ +--- +tags: resources, api +header: Interacting with the API +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- \ No newline at end of file diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md new file mode 100644 index 00000000..da8bde46 --- /dev/null +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -0,0 +1,6 @@ +--- +tags: resources, submission +header: Submission guide +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- diff --git a/src/_collections/resources/audit_submission/02-federal-program-contacts.md b/src/_collections/resources/audit_submission/02-federal-program-contacts.md new file mode 100644 index 00000000..c7d665b6 --- /dev/null +++ b/src/_collections/resources/audit_submission/02-federal-program-contacts.md @@ -0,0 +1,6 @@ +--- +tags: resources, submission +header: Federal program contacts +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- diff --git a/src/_collections/resources/audit_submission/03-SF-SAC.md b/src/_collections/resources/audit_submission/03-SF-SAC.md new file mode 100644 index 00000000..33d499d4 --- /dev/null +++ b/src/_collections/resources/audit_submission/03-SF-SAC.md @@ -0,0 +1,6 @@ +--- +tags: resources, submission +header: SF-SAC & instructions +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- diff --git a/src/_collections/resources/audit_submission/04-managing-access.md b/src/_collections/resources/audit_submission/04-managing-access.md new file mode 100644 index 00000000..0089268b --- /dev/null +++ b/src/_collections/resources/audit_submission/04-managing-access.md @@ -0,0 +1,6 @@ +--- +tags: resources, submission +header: Managing submission access +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- diff --git a/src/_collections/resources/audit_submission/05-burden-statement.md b/src/_collections/resources/audit_submission/05-burden-statement.md new file mode 100644 index 00000000..2648522d --- /dev/null +++ b/src/_collections/resources/audit_submission/05-burden-statement.md @@ -0,0 +1,6 @@ +--- +tags: resources, submission +header: Burden statement +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- diff --git a/src/_collections/resources/search/01-search-filters.md b/src/_collections/resources/search/01-search-filters.md new file mode 100644 index 00000000..87d2a97f --- /dev/null +++ b/src/_collections/resources/search/01-search-filters.md @@ -0,0 +1,6 @@ +--- +tags: resources, search +header: Search filters +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- \ No newline at end of file diff --git a/src/_collections/resources/search/02-search-results.md b/src/_collections/resources/search/02-search-results.md new file mode 100644 index 00000000..8869b9ac --- /dev/null +++ b/src/_collections/resources/search/02-search-results.md @@ -0,0 +1,6 @@ +--- +tags: resources, search +header: Search results +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- \ No newline at end of file diff --git a/src/_collections/resources/search/03-tribal-audits.md b/src/_collections/resources/search/03-tribal-audits.md new file mode 100644 index 00000000..8b26abb3 --- /dev/null +++ b/src/_collections/resources/search/03-tribal-audits.md @@ -0,0 +1,6 @@ +--- +tags: resources, search +header: Tribal audits +description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +link: '/' +--- \ No newline at end of file diff --git a/src/_includes/resources_page.njk b/src/_includes/resources_page.njk new file mode 100644 index 00000000..407cbf63 --- /dev/null +++ b/src/_includes/resources_page.njk @@ -0,0 +1,44 @@ +--- +layout: layout.njk +--- + +
+ {# Title and description, separated by a horizontal rule. #} +

{{header}}

+
+

{{description}}

+ + {# Cards are generated from the current pages 'collectionName'. To add more cards, navigate to collections and ensure the #} + + + {# Full-width FAQ page button, common to resource pages. #} + + {# href="/" #} +

+ Still have questions? + Visit our FAQ page + +

+ +
diff --git a/src/resources/api.md b/src/resources/api.md new file mode 100644 index 00000000..4be45c0c --- /dev/null +++ b/src/resources/api.md @@ -0,0 +1,10 @@ +--- +layout: resources_page.njk +title: FAC API resources +header: API resources +description: We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. +collectionName: resources, api +meta: + name: FAC API resources + description: Some content for describing this page. +--- \ No newline at end of file diff --git a/src/resources/audit-search.md b/src/resources/audit-search.md new file mode 100644 index 00000000..a250d56e --- /dev/null +++ b/src/resources/audit-search.md @@ -0,0 +1,10 @@ +--- +layout: resources_page.njk +title: FAC Audit search resources +header: Audit search resources +description: We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. +collectionName: resources, search +meta: + name: FAC Audit search resources + description: Some content for describing this page. +--- \ No newline at end of file diff --git a/src/resources/audit-submission.md b/src/resources/audit-submission.md new file mode 100644 index 00000000..ba63c390 --- /dev/null +++ b/src/resources/audit-submission.md @@ -0,0 +1,10 @@ +--- +layout: resources_page.njk +title: FAC Audit submission resources +header: Audit submission resources +description: We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. +collectionName: resources, submission +meta: + name: FAC Audit submission resources + description: Some content for describing this page. +--- \ No newline at end of file diff --git a/src/scss/main.scss b/src/scss/main.scss index a115800b..5e79cf9a 100644 --- a/src/scss/main.scss +++ b/src/scss/main.scss @@ -44,19 +44,27 @@ @extend %usa-date-picker__button !optional; } -.usa-card { +.usa-hero .usa-card { text-align:center; } -.usa-card .usa-card__container { +.usa-hero .usa-card .usa-card__container { padding: 2rem 0; } -.usa-card__container { +.usa-hero .usa-card__container { margin-top: 2rem; } -.usa-card p, .usa-card__body, .usa-card__body:last-child { +.usa-hero .usa-card p, .usa-card__body, .usa-card__body:last-child { padding-block-end: 0; margin-block-end: 0; } + +.resources .usa-card { + min-height: 96px; +} + +.resources .usa-card .usa-card__container .usa-card__header { + min-height: 96px; +} From 244787bdb68fa50b58d5414b0fe48954af8c77bb Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 08:39:56 -0500 Subject: [PATCH 02/79] updating submission resources hub --- src/resources/audit-submission.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/resources/audit-submission.md b/src/resources/audit-submission.md index ba63c390..476f29bf 100644 --- a/src/resources/audit-submission.md +++ b/src/resources/audit-submission.md @@ -1,10 +1,10 @@ --- layout: resources_page.njk -title: FAC Audit submission resources +title: Audit submission resources header: Audit submission resources -description: We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. +description: We’re here to help make your audit submission as easy as possible. Use our submission resources to complete the process. collectionName: resources, submission meta: - name: FAC Audit submission resources - description: Some content for describing this page. + name: Audit submission resources + description: Tools and resources for successfully submiting your single audit package to the Federal Audit Clearinghouse. --- \ No newline at end of file From 369a68ff9d9d27757c806e41c4273ceeadd973e1 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 08:45:38 -0500 Subject: [PATCH 03/79] adding submission guide card --- .../resources/audit_submission/01-submission-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md index da8bde46..16a6a7d3 100644 --- a/src/_collections/resources/audit_submission/01-submission-guide.md +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -1,6 +1,6 @@ --- tags: resources, submission header: Submission guide -description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '/' +description: An illustrated guide of the single audit process, from login to final submission. +link: 'resources/instructions' --- From 5724983ca26611c51bf20463559cb3c2f4018543 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 08:47:44 -0500 Subject: [PATCH 04/79] fixing links on cards --- .../resources/audit_submission/01-submission-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md index 16a6a7d3..037ce1d9 100644 --- a/src/_collections/resources/audit_submission/01-submission-guide.md +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -1,6 +1,6 @@ --- tags: resources, submission header: Submission guide -description: An illustrated guide of the single audit process, from login to final submission. -link: 'resources/instructions' +description: An illustrated guide to the single audit process, from login to final submission. +link: resources/instructions --- From ccc1e6773a1bc620bc86fe99d8816ce93b4ca8e7 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 08:51:41 -0500 Subject: [PATCH 05/79] link experimenting --- .../resources/audit_submission/01-submission-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md index 037ce1d9..32774dac 100644 --- a/src/_collections/resources/audit_submission/01-submission-guide.md +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -2,5 +2,5 @@ tags: resources, submission header: Submission guide description: An illustrated guide to the single audit process, from login to final submission. -link: resources/instructions +link: /resources/instructions --- From 4107d81bb6f16ffab958ddb3a0e51979e9bb5178 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 08:54:21 -0500 Subject: [PATCH 06/79] link again --- .../resources/audit_submission/01-submission-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md index 32774dac..f12a63a6 100644 --- a/src/_collections/resources/audit_submission/01-submission-guide.md +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -2,5 +2,5 @@ tags: resources, submission header: Submission guide description: An illustrated guide to the single audit process, from login to final submission. -link: /resources/instructions +link: ({{ config.baseUrl }}/resources/instructions) --- From 9171f56fd59f37942aadc89ec2cf6438149b2ffd Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 08:56:28 -0500 Subject: [PATCH 07/79] more link poking --- .../resources/audit_submission/01-submission-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md index f12a63a6..e9476515 100644 --- a/src/_collections/resources/audit_submission/01-submission-guide.md +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -2,5 +2,5 @@ tags: resources, submission header: Submission guide description: An illustrated guide to the single audit process, from login to final submission. -link: ({{ config.baseUrl }}/resources/instructions) +link: ({{ config.baseUrl }}resources/instructions) --- From 935cc37ede31c96b3a2f9e009a9459835307e3bb Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 08:59:24 -0500 Subject: [PATCH 08/79] another link attempt --- .../resources/audit_submission/01-submission-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md index e9476515..b04023e5 100644 --- a/src/_collections/resources/audit_submission/01-submission-guide.md +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -2,5 +2,5 @@ tags: resources, submission header: Submission guide description: An illustrated guide to the single audit process, from login to final submission. -link: ({{ config.baseUrl }}resources/instructions) +link: (resources/instructions) --- From 5d35138e4a514f4ef98a25b38a7473efca26a7ac Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 09:03:31 -0500 Subject: [PATCH 09/79] link desperation --- .../resources/audit_submission/01-submission-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md index b04023e5..7cfb7faa 100644 --- a/src/_collections/resources/audit_submission/01-submission-guide.md +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -2,5 +2,5 @@ tags: resources, submission header: Submission guide description: An illustrated guide to the single audit process, from login to final submission. -link: (resources/instructions) +link: 'resources/instructions' --- From b264d93d49684604f0b4ece305ddaf378a88b711 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 09:08:18 -0500 Subject: [PATCH 10/79] adding additional cards --- .../resources/audit_submission/01-submission-guide.md | 2 +- src/_collections/resources/audit_submission/02-SF-SAC.md | 6 ++++++ .../audit_submission/02-federal-program-contacts.md | 6 ------ src/_collections/resources/audit_submission/03-SF-SAC.md | 6 ------ .../resources/audit_submission/03-managing-access.md | 6 ++++++ .../audit_submission/04-federal-program-contacts.md | 6 ++++++ .../resources/audit_submission/04-managing-access.md | 6 ------ .../resources/audit_submission/05-burden-statement.md | 2 +- 8 files changed, 20 insertions(+), 20 deletions(-) create mode 100644 src/_collections/resources/audit_submission/02-SF-SAC.md delete mode 100644 src/_collections/resources/audit_submission/02-federal-program-contacts.md delete mode 100644 src/_collections/resources/audit_submission/03-SF-SAC.md create mode 100644 src/_collections/resources/audit_submission/03-managing-access.md create mode 100644 src/_collections/resources/audit_submission/04-federal-program-contacts.md delete mode 100644 src/_collections/resources/audit_submission/04-managing-access.md diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md index 7cfb7faa..f0e388be 100644 --- a/src/_collections/resources/audit_submission/01-submission-guide.md +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -2,5 +2,5 @@ tags: resources, submission header: Submission guide description: An illustrated guide to the single audit process, from login to final submission. -link: 'resources/instructions' +link: '/resources/instructions' --- diff --git a/src/_collections/resources/audit_submission/02-SF-SAC.md b/src/_collections/resources/audit_submission/02-SF-SAC.md new file mode 100644 index 00000000..cfcd3ab7 --- /dev/null +++ b/src/_collections/resources/audit_submission/02-SF-SAC.md @@ -0,0 +1,6 @@ +--- +tags: resources, submission +header: SF-SAC & instructions +description: Download the SF-SAC workbooks and find instructions for completing them. +link: '/' +--- diff --git a/src/_collections/resources/audit_submission/02-federal-program-contacts.md b/src/_collections/resources/audit_submission/02-federal-program-contacts.md deleted file mode 100644 index c7d665b6..00000000 --- a/src/_collections/resources/audit_submission/02-federal-program-contacts.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -tags: resources, submission -header: Federal program contacts -description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '/' ---- diff --git a/src/_collections/resources/audit_submission/03-SF-SAC.md b/src/_collections/resources/audit_submission/03-SF-SAC.md deleted file mode 100644 index 33d499d4..00000000 --- a/src/_collections/resources/audit_submission/03-SF-SAC.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -tags: resources, submission -header: SF-SAC & instructions -description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '/' ---- diff --git a/src/_collections/resources/audit_submission/03-managing-access.md b/src/_collections/resources/audit_submission/03-managing-access.md new file mode 100644 index 00000000..800742bf --- /dev/null +++ b/src/_collections/resources/audit_submission/03-managing-access.md @@ -0,0 +1,6 @@ +--- +tags: resources, submission +header: Managing submission access +description: Learn how to make changes to your certifying officials and audit submission editors. +link: '/' +--- diff --git a/src/_collections/resources/audit_submission/04-federal-program-contacts.md b/src/_collections/resources/audit_submission/04-federal-program-contacts.md new file mode 100644 index 00000000..60db959a --- /dev/null +++ b/src/_collections/resources/audit_submission/04-federal-program-contacts.md @@ -0,0 +1,6 @@ +--- +tags: resources, submission +header: Federal program contacts +description: Find your federal agency single audit contacts, key management liaisons, and program contacts. +link: '/' +--- diff --git a/src/_collections/resources/audit_submission/04-managing-access.md b/src/_collections/resources/audit_submission/04-managing-access.md deleted file mode 100644 index 0089268b..00000000 --- a/src/_collections/resources/audit_submission/04-managing-access.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -tags: resources, submission -header: Managing submission access -description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '/' ---- diff --git a/src/_collections/resources/audit_submission/05-burden-statement.md b/src/_collections/resources/audit_submission/05-burden-statement.md index 2648522d..d082ef31 100644 --- a/src/_collections/resources/audit_submission/05-burden-statement.md +++ b/src/_collections/resources/audit_submission/05-burden-statement.md @@ -1,6 +1,6 @@ --- tags: resources, submission header: Burden statement -description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +description: The FAC follows the Paperwork Reduction Act. See the estimated burden of completing the single audit submission process. link: '/' --- From c00c4447f364f40215c2f0e7fe3eb16500c8189a Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 09:16:36 -0500 Subject: [PATCH 11/79] links again --- .../resources/audit_submission/01-submission-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md index f0e388be..c14eaabc 100644 --- a/src/_collections/resources/audit_submission/01-submission-guide.md +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -2,5 +2,5 @@ tags: resources, submission header: Submission guide description: An illustrated guide to the single audit process, from login to final submission. -link: '/resources/instructions' +link: '/resources/instructions/' --- From 04a30dbbdd6627a57b9c8e05b07a0ccfa33a27fe Mon Sep 17 00:00:00 2001 From: James Person Date: Mon, 12 Feb 2024 09:35:11 -0500 Subject: [PATCH 12/79] Utilize baseUrl, no slashes at the front of card links --- src/_collections/resources/api/01-api-versioning.md | 2 +- src/_collections/resources/api/02-developer-resources.md | 2 +- src/_collections/resources/api/03-interacting-with-the-api.md | 2 +- .../resources/audit_submission/01-submission-guide.md | 2 +- src/_collections/resources/audit_submission/02-SF-SAC.md | 2 +- .../resources/audit_submission/03-managing-access.md | 2 +- .../resources/audit_submission/04-federal-program-contacts.md | 2 +- .../resources/audit_submission/05-burden-statement.md | 2 +- src/_collections/resources/search/01-search-filters.md | 2 +- src/_collections/resources/search/02-search-results.md | 2 +- src/_collections/resources/search/03-tribal-audits.md | 2 +- src/_includes/resources_page.njk | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/_collections/resources/api/01-api-versioning.md b/src/_collections/resources/api/01-api-versioning.md index cf7d8c99..a3d31162 100644 --- a/src/_collections/resources/api/01-api-versioning.md +++ b/src/_collections/resources/api/01-api-versioning.md @@ -2,5 +2,5 @@ tags: resources, api header: API versioning description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '/' +link: '' --- \ No newline at end of file diff --git a/src/_collections/resources/api/02-developer-resources.md b/src/_collections/resources/api/02-developer-resources.md index 8a2edd57..faca8786 100644 --- a/src/_collections/resources/api/02-developer-resources.md +++ b/src/_collections/resources/api/02-developer-resources.md @@ -2,5 +2,5 @@ tags: resources, api header: Developer resources description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '/' +link: '' --- \ No newline at end of file diff --git a/src/_collections/resources/api/03-interacting-with-the-api.md b/src/_collections/resources/api/03-interacting-with-the-api.md index 85d8de71..6d919d81 100644 --- a/src/_collections/resources/api/03-interacting-with-the-api.md +++ b/src/_collections/resources/api/03-interacting-with-the-api.md @@ -2,5 +2,5 @@ tags: resources, api header: Interacting with the API description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '/' +link: '' --- \ No newline at end of file diff --git a/src/_collections/resources/audit_submission/01-submission-guide.md b/src/_collections/resources/audit_submission/01-submission-guide.md index f0e388be..24aac0f1 100644 --- a/src/_collections/resources/audit_submission/01-submission-guide.md +++ b/src/_collections/resources/audit_submission/01-submission-guide.md @@ -2,5 +2,5 @@ tags: resources, submission header: Submission guide description: An illustrated guide to the single audit process, from login to final submission. -link: '/resources/instructions' +link: 'resources/instructions/' --- diff --git a/src/_collections/resources/audit_submission/02-SF-SAC.md b/src/_collections/resources/audit_submission/02-SF-SAC.md index cfcd3ab7..36eeb47b 100644 --- a/src/_collections/resources/audit_submission/02-SF-SAC.md +++ b/src/_collections/resources/audit_submission/02-SF-SAC.md @@ -2,5 +2,5 @@ tags: resources, submission header: SF-SAC & instructions description: Download the SF-SAC workbooks and find instructions for completing them. -link: '/' +link: '' --- diff --git a/src/_collections/resources/audit_submission/03-managing-access.md b/src/_collections/resources/audit_submission/03-managing-access.md index 800742bf..0dce6eba 100644 --- a/src/_collections/resources/audit_submission/03-managing-access.md +++ b/src/_collections/resources/audit_submission/03-managing-access.md @@ -2,5 +2,5 @@ tags: resources, submission header: Managing submission access description: Learn how to make changes to your certifying officials and audit submission editors. -link: '/' +link: '' --- diff --git a/src/_collections/resources/audit_submission/04-federal-program-contacts.md b/src/_collections/resources/audit_submission/04-federal-program-contacts.md index 60db959a..5b506b0e 100644 --- a/src/_collections/resources/audit_submission/04-federal-program-contacts.md +++ b/src/_collections/resources/audit_submission/04-federal-program-contacts.md @@ -2,5 +2,5 @@ tags: resources, submission header: Federal program contacts description: Find your federal agency single audit contacts, key management liaisons, and program contacts. -link: '/' +link: '' --- diff --git a/src/_collections/resources/audit_submission/05-burden-statement.md b/src/_collections/resources/audit_submission/05-burden-statement.md index d082ef31..490296be 100644 --- a/src/_collections/resources/audit_submission/05-burden-statement.md +++ b/src/_collections/resources/audit_submission/05-burden-statement.md @@ -2,5 +2,5 @@ tags: resources, submission header: Burden statement description: The FAC follows the Paperwork Reduction Act. See the estimated burden of completing the single audit submission process. -link: '/' +link: '' --- diff --git a/src/_collections/resources/search/01-search-filters.md b/src/_collections/resources/search/01-search-filters.md index 87d2a97f..93f4e077 100644 --- a/src/_collections/resources/search/01-search-filters.md +++ b/src/_collections/resources/search/01-search-filters.md @@ -2,5 +2,5 @@ tags: resources, search header: Search filters description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '/' +link: '' --- \ No newline at end of file diff --git a/src/_collections/resources/search/02-search-results.md b/src/_collections/resources/search/02-search-results.md index 8869b9ac..b3c3f497 100644 --- a/src/_collections/resources/search/02-search-results.md +++ b/src/_collections/resources/search/02-search-results.md @@ -2,5 +2,5 @@ tags: resources, search header: Search results description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '/' +link: '' --- \ No newline at end of file diff --git a/src/_collections/resources/search/03-tribal-audits.md b/src/_collections/resources/search/03-tribal-audits.md index 8b26abb3..46786e28 100644 --- a/src/_collections/resources/search/03-tribal-audits.md +++ b/src/_collections/resources/search/03-tribal-audits.md @@ -2,5 +2,5 @@ tags: resources, search header: Tribal audits description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '/' +link: '' --- \ No newline at end of file diff --git a/src/_includes/resources_page.njk b/src/_includes/resources_page.njk index 407cbf63..5fa29ed2 100644 --- a/src/_includes/resources_page.njk +++ b/src/_includes/resources_page.njk @@ -23,7 +23,7 @@ layout: layout.njk

- View + View
From d0f8a1ad365776a935a8075e242d21fc3c2a2297 Mon Sep 17 00:00:00 2001 From: James Person Date: Mon, 12 Feb 2024 09:47:13 -0500 Subject: [PATCH 13/79] Link to the FAQ page --- src/_includes/resources_page.njk | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/_includes/resources_page.njk b/src/_includes/resources_page.njk index 5fa29ed2..f0e3ba85 100644 --- a/src/_includes/resources_page.njk +++ b/src/_includes/resources_page.njk @@ -31,8 +31,7 @@ layout: layout.njk {# Full-width FAQ page button, common to resource pages. #} - - {# href="/" #} +

Still have questions? Visit our FAQ page From 70ac60466f509f0244dde1a66ca4feafb194abe5 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 09:48:07 -0500 Subject: [PATCH 14/79] adding the rest of the links --- src/_collections/resources/audit_submission/02-SF-SAC.md | 2 +- .../resources/audit_submission/03-managing-access.md | 2 +- .../resources/audit_submission/04-federal-program-contacts.md | 2 +- .../resources/audit_submission/05-burden-statement.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/_collections/resources/audit_submission/02-SF-SAC.md b/src/_collections/resources/audit_submission/02-SF-SAC.md index 36eeb47b..96d0d142 100644 --- a/src/_collections/resources/audit_submission/02-SF-SAC.md +++ b/src/_collections/resources/audit_submission/02-SF-SAC.md @@ -2,5 +2,5 @@ tags: resources, submission header: SF-SAC & instructions description: Download the SF-SAC workbooks and find instructions for completing them. -link: '' +link: 'resources/instructions/workbooks/' --- diff --git a/src/_collections/resources/audit_submission/03-managing-access.md b/src/_collections/resources/audit_submission/03-managing-access.md index 0dce6eba..aa94feeb 100644 --- a/src/_collections/resources/audit_submission/03-managing-access.md +++ b/src/_collections/resources/audit_submission/03-managing-access.md @@ -2,5 +2,5 @@ tags: resources, submission header: Managing submission access description: Learn how to make changes to your certifying officials and audit submission editors. -link: '' +link: 'resources/instructions/user-access/' --- diff --git a/src/_collections/resources/audit_submission/04-federal-program-contacts.md b/src/_collections/resources/audit_submission/04-federal-program-contacts.md index 5b506b0e..283b4379 100644 --- a/src/_collections/resources/audit_submission/04-federal-program-contacts.md +++ b/src/_collections/resources/audit_submission/04-federal-program-contacts.md @@ -2,5 +2,5 @@ tags: resources, submission header: Federal program contacts description: Find your federal agency single audit contacts, key management liaisons, and program contacts. -link: '' +link: 'resources/agency-contacts/' --- diff --git a/src/_collections/resources/audit_submission/05-burden-statement.md b/src/_collections/resources/audit_submission/05-burden-statement.md index 490296be..37ff49f3 100644 --- a/src/_collections/resources/audit_submission/05-burden-statement.md +++ b/src/_collections/resources/audit_submission/05-burden-statement.md @@ -2,5 +2,5 @@ tags: resources, submission header: Burden statement description: The FAC follows the Paperwork Reduction Act. See the estimated burden of completing the single audit submission process. -link: '' +link: 'resources/burdent-statement/' --- From 9fa46a2d3b99f840008984ece08dba058e31b595 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 11:08:25 -0500 Subject: [PATCH 15/79] fixing URLs --- src/_collections/resources/audit_submission/02-SF-SAC.md | 2 +- .../resources/audit_submission/05-burden-statement.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/_collections/resources/audit_submission/02-SF-SAC.md b/src/_collections/resources/audit_submission/02-SF-SAC.md index 96d0d142..708a5fbc 100644 --- a/src/_collections/resources/audit_submission/02-SF-SAC.md +++ b/src/_collections/resources/audit_submission/02-SF-SAC.md @@ -2,5 +2,5 @@ tags: resources, submission header: SF-SAC & instructions description: Download the SF-SAC workbooks and find instructions for completing them. -link: 'resources/instructions/workbooks/' +link: 'resources/workbooks/' --- diff --git a/src/_collections/resources/audit_submission/05-burden-statement.md b/src/_collections/resources/audit_submission/05-burden-statement.md index 37ff49f3..9e9551c1 100644 --- a/src/_collections/resources/audit_submission/05-burden-statement.md +++ b/src/_collections/resources/audit_submission/05-burden-statement.md @@ -2,5 +2,5 @@ tags: resources, submission header: Burden statement description: The FAC follows the Paperwork Reduction Act. See the estimated burden of completing the single audit submission process. -link: 'resources/burdent-statement/' +link: 'resources/burden-statement/' --- From 28c63e8ae7f351e28c88c90f2779048204817424 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 12 Feb 2024 11:31:10 -0500 Subject: [PATCH 16/79] search resources hub updates --- src/_collections/resources/search/01-search-filters.md | 4 ++-- src/_collections/resources/search/02-search-results.md | 6 +++--- src/_collections/resources/search/03-tribal-audits.md | 4 ++-- src/resources/audit-search.md | 8 ++++---- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/_collections/resources/search/01-search-filters.md b/src/_collections/resources/search/01-search-filters.md index 93f4e077..03c4f37d 100644 --- a/src/_collections/resources/search/01-search-filters.md +++ b/src/_collections/resources/search/01-search-filters.md @@ -1,6 +1,6 @@ --- tags: resources, search header: Search filters -description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '' +description: Learn about the FAC’s search filters and how to use them. +link: 'data/resources/' --- \ No newline at end of file diff --git a/src/_collections/resources/search/02-search-results.md b/src/_collections/resources/search/02-search-results.md index b3c3f497..21e5edf0 100644 --- a/src/_collections/resources/search/02-search-results.md +++ b/src/_collections/resources/search/02-search-results.md @@ -1,6 +1,6 @@ --- -tags: resources, search -header: Search results -description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. +tags: +header: Results tables definitions +description: This guide explains the table headers and data definitions for FAC search results. link: '' --- \ No newline at end of file diff --git a/src/_collections/resources/search/03-tribal-audits.md b/src/_collections/resources/search/03-tribal-audits.md index 46786e28..adac3342 100644 --- a/src/_collections/resources/search/03-tribal-audits.md +++ b/src/_collections/resources/search/03-tribal-audits.md @@ -1,6 +1,6 @@ --- tags: resources, search header: Tribal audits -description: Smiley was monstrous proud of his frog, and well he might be, for fellers that had traveled and been everywheres, all said he laid over any frog that ever they see. -link: '' +description: Accessing some audit data belonging to Tribes and Tribal entities requires special permissions. These instructions guide you through how to access these audits. +link: 'data/tribal/' --- \ No newline at end of file diff --git a/src/resources/audit-search.md b/src/resources/audit-search.md index a250d56e..a776be10 100644 --- a/src/resources/audit-search.md +++ b/src/resources/audit-search.md @@ -1,10 +1,10 @@ --- layout: resources_page.njk -title: FAC Audit search resources +title: Audit search resources header: Audit search resources -description: We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. +description: The Federal Audit Clearinghouse is the place to search for single audit submissions. You can search for audits for the current fiscal year or going back to 2016. The resources below will help you make the most of your search. collectionName: resources, search meta: - name: FAC Audit search resources - description: Some content for describing this page. + name: Audit search resources + description: Find resources and tools for making the most of your search for single audit submissions stored by the Federal Audit Clearinghouse. --- \ No newline at end of file From 8ff4b424294c132e9d5238b5e726e46e777f5c78 Mon Sep 17 00:00:00 2001 From: James Person Date: Mon, 12 Feb 2024 11:57:32 -0500 Subject: [PATCH 17/79] Seaprate FAQ links --- src/_includes/resources_page.njk | 2 +- src/resources/api.md | 1 + src/resources/audit-search.md | 1 + src/resources/audit-submission.md | 1 + 4 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/_includes/resources_page.njk b/src/_includes/resources_page.njk index f0e3ba85..aa2ae05f 100644 --- a/src/_includes/resources_page.njk +++ b/src/_includes/resources_page.njk @@ -31,7 +31,7 @@ layout: layout.njk {# Full-width FAQ page button, common to resource pages. #} - +

Still have questions? Visit our FAQ page diff --git a/src/resources/api.md b/src/resources/api.md index 4be45c0c..e905fe67 100644 --- a/src/resources/api.md +++ b/src/resources/api.md @@ -4,6 +4,7 @@ title: FAC API resources header: API resources description: We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. collectionName: resources, api +faqLink: https://example.com meta: name: FAC API resources description: Some content for describing this page. diff --git a/src/resources/audit-search.md b/src/resources/audit-search.md index a250d56e..3eea7ff6 100644 --- a/src/resources/audit-search.md +++ b/src/resources/audit-search.md @@ -4,6 +4,7 @@ title: FAC Audit search resources header: Audit search resources description: We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. We will put some copy here saying what this page is and how to use it. collectionName: resources, search +faqLink: https://example.com meta: name: FAC Audit search resources description: Some content for describing this page. diff --git a/src/resources/audit-submission.md b/src/resources/audit-submission.md index 476f29bf..714e4da2 100644 --- a/src/resources/audit-submission.md +++ b/src/resources/audit-submission.md @@ -4,6 +4,7 @@ title: Audit submission resources header: Audit submission resources description: We’re here to help make your audit submission as easy as possible. Use our submission resources to complete the process. collectionName: resources, submission +faqLink: https://example.com meta: name: Audit submission resources description: Tools and resources for successfully submiting your single audit package to the Federal Audit Clearinghouse. From 92545e1f2235e1a0f8d256a85ceae756b40ee8da Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Tue, 13 Feb 2024 11:18:21 -0500 Subject: [PATCH 18/79] adding FAQ links --- src/resources/audit-search.md | 2 +- src/resources/audit-submission.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/resources/audit-search.md b/src/resources/audit-search.md index 5e0d1e10..defa490b 100644 --- a/src/resources/audit-search.md +++ b/src/resources/audit-search.md @@ -4,7 +4,7 @@ title: Audit search resources header: Audit search resources description: The Federal Audit Clearinghouse is the place to search for single audit submissions. You can search for audits for the current fiscal year or going back to 2016. The resources below will help you make the most of your search. collectionName: resources, search -faqLink: https://example.com +faqLink: https://support.fac.gov/hc/en-us/categories/18291273575181-Audit-Search meta: name: Audit search resources description: Find resources and tools for making the most of your search for single audit submissions stored by the Federal Audit Clearinghouse. diff --git a/src/resources/audit-submission.md b/src/resources/audit-submission.md index 714e4da2..8e80c951 100644 --- a/src/resources/audit-submission.md +++ b/src/resources/audit-submission.md @@ -4,7 +4,7 @@ title: Audit submission resources header: Audit submission resources description: We’re here to help make your audit submission as easy as possible. Use our submission resources to complete the process. collectionName: resources, submission -faqLink: https://example.com +faqLink: https://support.fac.gov/hc/en-us/categories/18291221922829-Audit-Submission meta: name: Audit submission resources description: Tools and resources for successfully submiting your single audit package to the Federal Audit Clearinghouse. From dbe7b647675ce28ae0c99002c981db3f6d119f37 Mon Sep 17 00:00:00 2001 From: James Person Date: Wed, 14 Feb 2024 12:36:18 -0500 Subject: [PATCH 19/79] Res. page descriptions -> content. Margins & fonts --- src/_includes/resources_page.njk | 8 ++++---- src/resources/api.md | 5 +++-- src/resources/audit-search.md | 5 +++-- src/resources/audit-submission.md | 5 +++-- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/src/_includes/resources_page.njk b/src/_includes/resources_page.njk index aa2ae05f..00babd9b 100644 --- a/src/_includes/resources_page.njk +++ b/src/_includes/resources_page.njk @@ -6,16 +6,16 @@ layout: layout.njk {# Title and description, separated by a horizontal rule. #}

{{header}}

-

{{description}}

+
{{content | safe}}
{# Cards are generated from the current pages 'collectionName'. To add more cards, navigate to collections and ensure the #} - -

For more information on the features and development of the new FAC.gov, check out our Updates page.

From 443cbfc2a07222ffd8c0c5ed9bd7f58ecdd411d5 Mon Sep 17 00:00:00 2001 From: Matt Jadud Date: Fri, 1 Mar 2024 12:46:05 -0500 Subject: [PATCH 47/79] Addin --- src/_collections/resources/api/09-tribal.md | 6 + src/api/tribal.md | 173 ++++++++++++++++++++ 2 files changed, 179 insertions(+) create mode 100644 src/_collections/resources/api/09-tribal.md create mode 100644 src/api/tribal.md diff --git a/src/_collections/resources/api/09-tribal.md b/src/_collections/resources/api/09-tribal.md new file mode 100644 index 00000000..efdd72ad --- /dev/null +++ b/src/_collections/resources/api/09-tribal.md @@ -0,0 +1,6 @@ +--- +tags: resources, api +header: Tribal data access +description: Access data and Single Audit Reports via the API that Tribes and Tribal Organizations have chosen to suppress. +link: 'api/tribal' +--- \ No newline at end of file diff --git a/src/api/tribal.md b/src/api/tribal.md new file mode 100644 index 00000000..41e42d3b --- /dev/null +++ b/src/api/tribal.md @@ -0,0 +1,173 @@ +--- +layout: home.njk +title: Accessing suppressed Tribal data via the API +meta: + name: Accessing Tribal data via the API + description: How to access suppressed SF-SAC/SAR data. +--- + +# Accessing suppressed Tribal data via the API + +Tribes and Tribal Organizations have the option, per [2 CFR 200.512(b)(2)](https://www.ecfr.gov/current/title-2/part-200/subpart-F#p-200.512(b)(2)), to suppress their Single Audit data. + +> Exception for Indian Tribes and Tribal Organizations. An auditee that is an Indian tribe or a tribal organization (as defined in the Indian Self-Determination, Education and Assistance Act (ISDEAA), 25 U.S.C. 450b(l)) may opt not to authorize the FAC to make the reporting package publicly available on a Web site, by excluding the authorization for the FAC publication in the statement described in paragraph (b)(1) of this section. If this option is exercised, the auditee becomes responsible for submitting the reporting package directly to any pass-through entities through which it has received a Federal award and to pass-through entities for which the summary schedule of prior audit findings reported the status of any findings related to Federal awards that the pass-through entity provided. Unless restricted by Federal statute or regulation, if the auditee opts not to authorize publication, it must make copies of the reporting package available for public inspection. + +For users of the API, this means that some Tribal records will have the field `is_public` in the `/general` endpoint set to `False`. This means the Tribe or Tribal Organization has opted to exercise its rights under the ISDEAA and UG to suppress some parts of the SF-SAC as well as the Single Audit Report. + +Federal agencies engaged in oversight, who are using the API, can still access the suppressed portions of the audit. In order to do so, they will need to: + +1. Request a copy of the Tribal API Access Agreement via the [helpdesk](https://support.fac.gov/hc/en-us). +2. Complete the agreement and return it to the FAC as described in the agreement. + +## Working with the data + +The SF-SAC data contained in the API is not "different" when using a "Tribal API key" vs. a key that grants public access. However, there are extensions to the API that are necessary to access the Single Audit Reports (SARs). It is always the case that public reports can be accessed directly, because they are public data. To access a Tribal SAR that has been suppressed, you must: + +1. Make an authenticated request for a one-time access token. +2. Use the one-time token to download the PDF. + +What follows are instructions for Federal developers working with Tribal data via the FAC API to access the SARs. + +## Step 1: Fetch Data About a Submission + +This step retrieves data about a submission based on the provided report ID. + +### Endpoint + +`GET /general?report_id=eq.{report_id}` + +### Parameters + +* `report_id` (required): The ID of the report you want to fetch data for. + +### Headers + +* `content-profile`: Set to `api_v1_1_0`. +* `x-api-key`: Your Tribal API key. +* `content-type`: Set to `application/json`. + +### Response + +* `200 OK`: Returns JSON data containing information about the submission. +* Error Responses: + * `404 Not Found`: If the report ID does not exist. + * `401 Unauthorized`: If the request lacks proper authentication. + +### Code + +``` +import requests + +def fetch_submission_data(report_id): + url = '/api.fac.gov/general?report_id=eq.{report_id}' + response = requests.get(url, headers=headers) + if response.status_code == 200: + submission_data = response.json() + return submission_data +``` + +## Step 2: Fetch Data About a Submission + +After fetching submission data, you can request access to download the associated file. + +### Endpoint + +`POST /api.fac.gov/rpc/request_file_access` + +### Parameters + +* `report_id (required)`: The ID of the report for which you're requesting file access. + +### Headers + +* `content-profile`: Set to `api_v1_1_0`. +* `x-api-key`: Your Tribal API key. +* `content-type`: Set to `application/json`. + +### Response + +* `200 OK`: Returns access information, including an access UUID. +* Error Responses: + * `401 Unauthorized`: If the request lacks proper authentication. + * `404 Not Found`: If the report ID does not exist. + +### Code + +``` +import json +import requests + +def request_file_access(report_id): + url = '/api.fac.gov/rpc/request_file_access' + headers = { + 'content-Profile': 'admin_api_v1_1_0', + 'x-api-key': f'{API_KEY}', + 'Content-Type': 'application/json', + } + payload = json.dumps({ + "report_id": f'{report_id}' + }) + response = requests.post(url, headers=headers, data=payload) + if response.status_code == 200: + access_info = response.json() + # `access_info` is a JSON object containing + # a one-time token needed to download a suppressed SAR. + return access_info +``` + +## Step 3: Download the file + +Once you have the access information, you can use it to download the associated file. Use the access UUID that was retrieved in the last step to get the file. + +### Endpoint: +`GET /app.fac.gov/dissemination/report/pdf/ota/{access_uuid}` + +### Parameters + +`access_uuid (required)`: The access UUID obtained from the request_file_access endpoint. + +### Headers + +None required; this is a straight `GET` request to download a file. + +### Response + +* `200 OK`: Downloads the file successfully. +* Error Responses: + * `401 Unauthorized`: If the request lacks proper authentication. + * `404 Not Found`: If the access UUID is invalid or the file doesn't exist. + +Other HTTP status codes indicate various error scenarios. + +### Code + +``` +import requests + +############################################## +# Note we download the PDF from `app.fac.gov`, +# not from `api.fac.gov`. +############################################## +def download_file(access_info): + access_uuid_value = access_info.get('access_uuid') + url = '/app.fac.gov/dissemination/report/pdf/ota/{access_uuid_value}' + payload = {} + try: + response = requests.get(url, headers=headers, data=payload) + if response.status_code == 200: + with open("downloaded_file.pdf", "wb") as pdf_file: + pdf_file.write(response.content) + print("File downloaded successfully.") + else: + print("Failed to download file. Status code:", response.status_code) + print("Response content:", response.text) + except Exception as e: + print("Error occurred while downloading file:", e) +``` + +## Notes + +1. The access token is only good for 1 minute. +2. When you access the URL at `pdf/ota/{access_uuid}`, you will be redirected to a temporary Amazon AWS URL. It, too, has a lifetime of a minute or less. + +Do not bother attempting to store or cache either of these temporary URLs. Every time you want to access a PDF via the API, you will need to go through the three steps outlined above. \ No newline at end of file From 2e3a47e83c718df7118c8169da9c2735201963d1 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Fri, 1 Mar 2024 15:20:58 -0500 Subject: [PATCH 48/79] copy updates to tribal api page --- src/api/tribal.md | 64 +++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 36 deletions(-) diff --git a/src/api/tribal.md b/src/api/tribal.md index 41e42d3b..2be18e04 100644 --- a/src/api/tribal.md +++ b/src/api/tribal.md @@ -3,57 +3,49 @@ layout: home.njk title: Accessing suppressed Tribal data via the API meta: name: Accessing Tribal data via the API - description: How to access suppressed SF-SAC/SAR data. + description: How to access suppressed SF-SAC data. --- # Accessing suppressed Tribal data via the API -Tribes and Tribal Organizations have the option, per [2 CFR 200.512(b)(2)](https://www.ecfr.gov/current/title-2/part-200/subpart-F#p-200.512(b)(2)), to suppress their Single Audit data. +Tribes and Tribal organizations have the option, per [2 CFR 200.512(b)(2)](https://www.ecfr.gov/current/title-2/part-200/subpart-F#p-200.512(b)(2)), to suppress their Single Audit data. -> Exception for Indian Tribes and Tribal Organizations. An auditee that is an Indian tribe or a tribal organization (as defined in the Indian Self-Determination, Education and Assistance Act (ISDEAA), 25 U.S.C. 450b(l)) may opt not to authorize the FAC to make the reporting package publicly available on a Web site, by excluding the authorization for the FAC publication in the statement described in paragraph (b)(1) of this section. If this option is exercised, the auditee becomes responsible for submitting the reporting package directly to any pass-through entities through which it has received a Federal award and to pass-through entities for which the summary schedule of prior audit findings reported the status of any findings related to Federal awards that the pass-through entity provided. Unless restricted by Federal statute or regulation, if the auditee opts not to authorize publication, it must make copies of the reporting package available for public inspection. +For Tribes and Tribal organizations who choose to protect their data, the API will show is_public in the /general endpoint set to False. -For users of the API, this means that some Tribal records will have the field `is_public` in the `/general` endpoint set to `False`. This means the Tribe or Tribal Organization has opted to exercise its rights under the ISDEAA and UG to suppress some parts of the SF-SAC as well as the Single Audit Report. - -Federal agencies engaged in oversight, who are using the API, can still access the suppressed portions of the audit. In order to do so, they will need to: - -1. Request a copy of the Tribal API Access Agreement via the [helpdesk](https://support.fac.gov/hc/en-us). -2. Complete the agreement and return it to the FAC as described in the agreement. +If you believe you should have access to these audits, you will need to request a copy of the Tribal API Access Agreement via the [helpdesk](https://support.fac.gov/hc/en-us). ## Working with the data -The SF-SAC data contained in the API is not "different" when using a "Tribal API key" vs. a key that grants public access. However, there are extensions to the API that are necessary to access the Single Audit Reports (SARs). It is always the case that public reports can be accessed directly, because they are public data. To access a Tribal SAR that has been suppressed, you must: - -1. Make an authenticated request for a one-time access token. -2. Use the one-time token to download the PDF. +Your Tribal access API key will let you request a one-time access token. You'll use this token to download suppressed reports. -What follows are instructions for Federal developers working with Tribal data via the FAC API to access the SARs. +Once you have your token, use the instructions below to complete your API set-up: -## Step 1: Fetch Data About a Submission +### Step 1: Fetch Data About a Submission This step retrieves data about a submission based on the provided report ID. -### Endpoint +#### Endpoint `GET /general?report_id=eq.{report_id}` -### Parameters +#### Parameters * `report_id` (required): The ID of the report you want to fetch data for. -### Headers +#### Headers * `content-profile`: Set to `api_v1_1_0`. * `x-api-key`: Your Tribal API key. * `content-type`: Set to `application/json`. -### Response +#### Response * `200 OK`: Returns JSON data containing information about the submission. * Error Responses: * `404 Not Found`: If the report ID does not exist. * `401 Unauthorized`: If the request lacks proper authentication. -### Code +#### Code ``` import requests @@ -66,32 +58,32 @@ def fetch_submission_data(report_id): return submission_data ``` -## Step 2: Fetch Data About a Submission +### Step 2: Fetch Data About a Submission After fetching submission data, you can request access to download the associated file. -### Endpoint +#### Endpoint `POST /api.fac.gov/rpc/request_file_access` -### Parameters +#### Parameters * `report_id (required)`: The ID of the report for which you're requesting file access. -### Headers +#### Headers * `content-profile`: Set to `api_v1_1_0`. * `x-api-key`: Your Tribal API key. * `content-type`: Set to `application/json`. -### Response +#### Response * `200 OK`: Returns access information, including an access UUID. * Error Responses: * `401 Unauthorized`: If the request lacks proper authentication. * `404 Not Found`: If the report ID does not exist. -### Code +#### Code ``` import json @@ -115,22 +107,22 @@ def request_file_access(report_id): return access_info ``` -## Step 3: Download the file +### Step 3: Download the file Once you have the access information, you can use it to download the associated file. Use the access UUID that was retrieved in the last step to get the file. -### Endpoint: +#### Endpoint: `GET /app.fac.gov/dissemination/report/pdf/ota/{access_uuid}` -### Parameters +#### Parameters `access_uuid (required)`: The access UUID obtained from the request_file_access endpoint. -### Headers +#### Headers None required; this is a straight `GET` request to download a file. -### Response +#### Response * `200 OK`: Downloads the file successfully. * Error Responses: @@ -139,7 +131,7 @@ None required; this is a straight `GET` request to download a file. Other HTTP status codes indicate various error scenarios. -### Code +#### Code ``` import requests @@ -165,9 +157,9 @@ def download_file(access_info): print("Error occurred while downloading file:", e) ``` -## Notes +### Notes -1. The access token is only good for 1 minute. -2. When you access the URL at `pdf/ota/{access_uuid}`, you will be redirected to a temporary Amazon AWS URL. It, too, has a lifetime of a minute or less. +- The access token is only good for 1 minute. +- When you access the URL at `pdf/ota/{access_uuid}`, you'll be redirected to a temporary Amazon AWS URL. This is also only good for 1 minute or less. -Do not bother attempting to store or cache either of these temporary URLs. Every time you want to access a PDF via the API, you will need to go through the three steps outlined above. \ No newline at end of file +**These temporary URLs can't be stored or cached.** Every time you want to access a suppressed report via the API, you'll need to go through the steps outlined above. \ No newline at end of file From 1244127ad0cbc9e3a7f90ef38300a9c8bf99bf47 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Fri, 1 Mar 2024 15:33:50 -0500 Subject: [PATCH 49/79] fixing tribal api headlines --- src/api/tribal.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/api/tribal.md b/src/api/tribal.md index 2be18e04..f04db65f 100644 --- a/src/api/tribal.md +++ b/src/api/tribal.md @@ -20,7 +20,7 @@ Your Tribal access API key will let you request a one-time access token. You'll Once you have your token, use the instructions below to complete your API set-up: -### Step 1: Fetch Data About a Submission +### Step 1: Fetch data about a submission This step retrieves data about a submission based on the provided report ID. @@ -58,7 +58,7 @@ def fetch_submission_data(report_id): return submission_data ``` -### Step 2: Fetch Data About a Submission +### Step 2: Request file access After fetching submission data, you can request access to download the associated file. From 1b3127efb63d2f02b1f46ca4e84af6fa46decad7 Mon Sep 17 00:00:00 2001 From: James Person Date: Wed, 6 Mar 2024 10:21:00 -0500 Subject: [PATCH 50/79] Remove old pages, implement redirects --- src/_includes/header.njk | 4 +- src/_includes/redirect.njk | 10 +++++ src/audits/index.md | 36 ---------------- src/developers/api-versioning.md | 56 ------------------------- src/developers/getting-started.md | 68 ------------------------------- src/developers/index.md | 43 ------------------- src/developers/terms.md | 16 -------- src/redirects.md | 46 +++++++++++++++++++++ 8 files changed, 58 insertions(+), 221 deletions(-) create mode 100644 src/_includes/redirect.njk delete mode 100644 src/audits/index.md delete mode 100644 src/developers/api-versioning.md delete mode 100644 src/developers/getting-started.md delete mode 100644 src/developers/index.md delete mode 100644 src/developers/terms.md create mode 100644 src/redirects.md diff --git a/src/_includes/header.njk b/src/_includes/header.njk index b6ae6864..c94f3128 100644 --- a/src/_includes/header.njk +++ b/src/_includes/header.njk @@ -18,7 +18,7 @@ -
+
    {% for section in global.navigation.primary %} {% if section.links %} @@ -60,7 +60,7 @@ Helpdesk -
  • +
  • OMB# 3090-0330 EXP: 09/30/2026
diff --git a/src/_includes/redirect.njk b/src/_includes/redirect.njk new file mode 100644 index 00000000..9616b7b2 --- /dev/null +++ b/src/_includes/redirect.njk @@ -0,0 +1,10 @@ + + + + + + + + You are being redirected to {{ redirect.to }} + + \ No newline at end of file diff --git a/src/audits/index.md b/src/audits/index.md deleted file mode 100644 index 665a89d0..00000000 --- a/src/audits/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: home.njk -title: Single audit submission resources -meta: - name: Single audit submission resources - description: Find resources and instructions for completing the single audit process. ---- - -# Single audit submission resources - -Our goal is to make the single audit submission process as easy as possible. - -## Submission guide - -Our [submission guide]({{ config.baseUrl }}resources/instructions) will take you through submitting a single audit, from creating a Login.gov account to completing the SF-SAC workbooks to certification and submission. - -## Managing submission access - -These [instructions]({{ config.baseUrl }}resources/instructions/user-access) will walk you through making changes to your certifying officials and adding new audit editors. - -## SF-SAC workbooks - -Download the workbooks needed to complete your SF-SAC and find instructions for completing them below. - -- [SF-SAC Section 1: Federal awards]({{ config.baseUrl }}resources/workbooks/federal-awards) -- [SF-SAC Section 2: Notes to SEFA]({{ config.baseUrl }}resources/workbooks/notes-to-sefa) -- [SF-SAC Section 3: Federal awards findings]({{ config.baseUrl }}resources/workbooks/federal-awards-audit-findings) -- [SF-SAC Section 4: Federal awards findings text]({{ config.baseUrl }}resources/workbooks/federal-awards-audit-findings-text) -- [SF-SAC Section 5: Corrective action plan]({{ config.baseUrl }}resources/workbooks/corrective-action-plan) -- [SF-SAC Section 6: Additional UEIs (optional)]({{ config.baseUrl }}resources/workbooks/additional-ueis-workbook) -- [SF-SAC Section 7: Secondary auditors (optional)]({{ config.baseUrl }}resources/workbooks/secondary-auditors-workbook) -- [SF-SAC Section 8: Additional EINs (optional)]({{ config.baseUrl }}resources/workbooks/additional-eins-workbook) - -## Federal agency program contacts - -[This PDF]({{ config.baseUrl }}assets/agency-contacts/2023-agency-contacts.pdf) provides the contact information for federal agency single audit contacts, key management liaisons, and program contacts. These individuals can answer your audit questions. \ No newline at end of file diff --git a/src/developers/api-versioning.md b/src/developers/api-versioning.md deleted file mode 100644 index 43d9bbe6..00000000 --- a/src/developers/api-versioning.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: home.njk -title: FAC API versioning -meta: - name: FAC API versioning - description: Learn how the FAC manages versions of the FAC API. ---- - -# FAC API versioning - -This page describes how the FAC API will change over time, how those changes will be communicated, and how to understand the FAC APIs naming conventions. On October 1, 2023, these conventions will become operating procedure. - -## API naming conventions - -* Each release name contains a version in modified [SemVer](https://semver.org/) format: MAJOR, MINOR. -* Version numbers use underscores instead of dots so that our API names are valid Postgresql schema names. -* API names start with `api_` so we can distinguish them from other schemas during development. -* API names might end with a prerelease designation like `-beta`. - -For example: - -* `api_v1_0_0` - Indicates first frozen version, this is the default API pushed to users -* `api_v1_0_1` - Indicates a bug fix, these changes are automatically pushed to all users -* `api_v1_1_0` - Indicates the addition of a new feature, users may opt into using this version -* `api_v2_0_0` - Indicates new features have become the default version. All users will have to switch to this version and update their API access to avoid incompatability with older clients. - -## Offering multiple API versions in parallel - -The FAC API can provide multiple versions of the API at the same time using [PostgREST's schema](https://postgrest.org/en/stable/references/api/schemas.html) functionality. A full list of available schemas will be documented here as they become available. - -While you can specify a particular schema when making a request, If you don't specify a particular API version in your request, the FAC API defaults to the most recent stable version. See the [PostgREST schema documenation](https://postgrest.org/en/stable/references/api/schemas.html#get-head) for guidance on specifying a version in your request. - -For example, if the FAC API theoretically supported the versions `v1.1.0, v2.0.0, v3.0.0-beta`: - -* `v2.0.0` is the most recent stable version. If you don’t specify a different API, you'll get `v2.0.0`. -* `v1.1.0` is the most recent release for the previous stable version. It is available, but you have to request it explicitly. -* `v1.0.0` is obsolete and is no longer available. `v1.1.0` is a more recent, MINOR update to `v1.0.0`. -* `v3.0.0-beta` is a prerelease for the next major, unreleased version. It is available, but you have to request it explicitly. - -### Bugfixes and pre-releases - -There may be some instances in which the most recent SemVer release is not the default for its MAJOR release. For example, we may opt to run a short test to confirm that a bug is fixed before making a particular release the default. This should be rare and is unlikely to impact regular API users. - -You should not assume that a particular pre-release version will be available for any amount of time. They are intended primarily for testing and will likely rotate through the list of releases quickly. - -## Migrating to new versions - -Prior to a MAJOR release, we will publish a rough release timeline to help the community prepare for any breaking changes. Once an early prerelease version is ready, we will make an announcement and seek test volunteers from our user community. - -When we're confident in a new version of the API, we will announce the new version as a non-default, opt-in version for more users. We'll also post when the new version will become the default (e.g. T+3 months). During this period, users can opt-in to using this new version to ensure their processes will still work before it becomes the default. - -Once a new version becomes the default, we'll announce the date that the older version will be removed from service (e.g. T+12 months). Users will still be able to use the deprecated version by request until the removal date. - -Our goal with this process is to ensure that users aren't rushed into migrating new versions and have ample time to prepare. At the same time, we can't commit to supporting old APIs indefinitely. - -This process will apply to all changes to the API, both MAJOR and MINOR. diff --git a/src/developers/getting-started.md b/src/developers/getting-started.md deleted file mode 100644 index 4ac9a0de..00000000 --- a/src/developers/getting-started.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -layout: home.njk -title: Using the FAC API -meta: - name: Using the FAC API - description: Begin using the FAC API by learning more about our endpoints and test scenarios. ---- - -# Using the FAC API - -Once you have a key from [api.data.gov](https://api.data.gov/), you're ready to begin using the FAC API. - -The examples in this repository assume that you have two environment variables set. In a Bash shell, you would: - -``` -export API_GOV_KEY="..." -export API_GOV_URL="https://api-staging.fac.gov" -``` - -Those two environment variables must be present in your shell for the code provided to work "as is." - -If you are on Windows, you can either use the Windows Subshell for Linux (WSL) to run the code, or in a Windows command shell: - -``` -set API_GOV_KEY="as above..." -set API_GOV_URL="as above..." -``` - -*We have not tested this code under Windows. If you do, please share your experience in our [Git discussions](https://github.com/GSA-TTS/FAC/discussions).* - -## API endpoints - -You can set `API_GOV_URL` to one of four URLs: - -1. `api.fac.gov`: This endpoint is is for current, submitted data. Production services should use this endpoint. It is typically updated once per week on Wednesdays. -2. `api-staging.fac.gov`: This endpoint will contain a mix of submitted data as well as test data. This environment is updated daily at 5 a.m. ET. -3. `api-dev.fac.gov`: This endpoint may contain a mix of submitted and test data. Every time we accept a pull request into `main`, this environment updates. `dev` is considered unstable. -4. `api-preview.fac.gov`: This is a testing environment for our FAC developers. You shouldn't use `preview` unless asked to by the FAC team. - -## Testing the API - -From the command line, you should be able to use `curl` to execute a simple query against the API if everything is working: - -``` -curl -s -X "GET" \ - -H "X-Api-Key: ${API_GOV_KEY}" \ - "${API_GOV_URL}/general?limit=5" -``` - -This will return an [array of JSON objects](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON). Each object will represent a row in the general information table, which roughly maps to the `gen.txt` file that Census has historically exported from their download page. - -To format the results in a cleaner way, you can use `jq`: - -``` -curl -s -X "GET" \ - -H "X-Api-Key: ${API_GOV_KEY}" \ - "${API_GOV_URL}/general?limit=5" | jq -``` - -Because `jq` is a general-purpose tool for manipulating JSON, you could get a list of the report IDs that you found: - -``` -curl -s -X "GET" \ - -H "X-Api-Key: ${API_GOV_KEY}" \ - "${API_GOV_URL}/general?limit=5" | jq '.[] | .report_id' -``` - -These are examples of how to use tools like `curl` and `jq` to build automations against the FAC API. You can also use other coding languages, like Java, Python, or even Excel macros. \ No newline at end of file diff --git a/src/developers/index.md b/src/developers/index.md deleted file mode 100644 index 13b09e7f..00000000 --- a/src/developers/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: home.njk -title: FAC API documentation -meta: - name: FAC API documentation - description: Find developer resources for using the FAC API, including how to obtain a key and terms and conditions. ---- - -# The FAC API - -The FAC API shares public data from submitted audit reports. The FAC API runs on PostgREST and supports its built-in query operations. - -## Migrating from Census-provided data - -The FAC API endpoints mimic the pipe-delimited CSV files historically provided by Census. This means we export a similar set of tables (e.g. `general` as opposed to `gen`) with similar column titles. There are, however, some differences between GSA-provided and Census-provided data. We will provide more detailed migration guidance in the coming months. - -## Interacting with the API - -To interact with the FAC API, you will need an API key from Data.gov. To get a Data.gov API key, fill out the Data.gov API key signup form. This is free and requires a valid email address. When you receive your API key, treat it like any other credential: -- Do not share your key with other users. -- Do not commit your key into a repository alongside your code. -- Do not store your key in a shared drive where other users have access. -- Do not share your key in helpdesk requests or any other communication. - -Once you have your API key, you can begin exploring the API. - -## Resources - -* [Getting started]({{ config.baseUrl }}developers/getting-started/). What you need to get started, with some examples using `curl` on the command line. -* [PostgREST](https://postgrest.org), our API server. We use PostgREST as our API server. That means that you will use their documentation to guide you in formulating queries and interacting with our API server. -* [GSA data dictionary]({{ config.baseUrl }}developers/dictionary/). A mapping from the Census FAC to the GSA FAC API -* [Rollup fields]({{ config.baseUrl }}developers/rollups/) in Census data. A look at fields that existed in the Census data dissemination, and how to compute them from the FAC API. -* [Differences]({{ config.baseUrl }}developers/differences/) between Census data fields and GSA data fields. A list of fields you might be looking for, and where you might find them in the GSA FAC API. -* [Retrieiving many results]({{ config.baseUrl }}developers/retrieve-many/). An example of how to use pagination in PostgREST to retrieve many results from the API. - -## API limits and future updates - -By default, each API key is limited to 1,000 requests per hour. This limit comes from Data.gov, and you can read more about it in the api.data.gov developer manual. - -As the API evolves, we will publish API updates and communicate guidance according to our change management process. You can read more on the [API versioning page]({{ config.baseUrl }}developers/api-versioning/). - -For more information on the FAC API and the information it provides, see our [terms and conditions]({{ config.baseUrl }}developers/terms/). - diff --git a/src/developers/terms.md b/src/developers/terms.md deleted file mode 100644 index 58909438..00000000 --- a/src/developers/terms.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: home.njk -title: FAC API terms and conditions -name: FAC API terms and conditions -description: Read the terms and conditions of accessing single audit data via the FAC API. ---- - -# FAC API terms and conditions - -The Federal Audit Clearinghouse is charged with disseminating Single Audit data to support Federal oversight of grants as well as public interest. - -The Federal Audit Clearinghouse operates on behalf of the Office of Management and Budget. We distribute single audit reporting packages to federal agencies and the public. - -All single audit reporting packages, with the possible exception of Indian Tribes and Tribal Organizations, submitted under Uniform Guidance are available to the public per 2 CFR 200.512(b)(1). - -Indian Tribes and Tribal Organizations may choose to keep their reporting packages unavailable to the public per 2 CFR 200.512(b)(2). For these entities, the notes to the Schedule of Expenditures of Federal Awards (SEFA), text of audit findings, and their corrective action plan will not be available to the public for fiscal periods ending in 2019 or later. diff --git a/src/redirects.md b/src/redirects.md new file mode 100644 index 00000000..d9dceef6 --- /dev/null +++ b/src/redirects.md @@ -0,0 +1,46 @@ +--- +# This method of redirecting comes from user @warpfork +# https://github.com/11ty/eleventy/issues/510#issuecomment-824104799 + +# This file does hijinx with the "pagination" system to generate many small pages from one set of data... +# and uses that do to redirects from some URLs to others. +# We use this to try to keep old links working. +# +# There's limited power to this approach (it only works for specific pages listed; it can't glob), +# but those are limitations inherent to an approach that works via static site gen, rather than via server configuration. +# The related upside of an approach that works via static site gen is the portability. +pagination: + data: redirects + size: 1 + alias: redirect +redirects: +# Search resources + - {"from": "/data/resources/", "to": "/search-resources/"} + - {"from": "/data/tribal/", "to": "/search-resources/tribal/"} +# API pages + - {"from": "/developers/", "to": "/api/"} + - {"from": "/developers/dictionary/", "to": "/api/dictionary/"} + - {"from": "/developers/getting-started/", "to": "/api/getting-started/"} + - {"from": "/developers/rollups/", "to": "/api/rollup/"} + - {"from": "/developers/differences/", "to": "/api/differences/"} + - {"from": "/developers/api-versioning/", "to": "/api/versioning/"} + - {"from": "/developers/terms/", "to": "/api/terms/"} +# Audit resources + - {"from": "/audits/", "to": "/audit-resources/"} + - {"from": "/resources/instructions/", "to": "/audit-resources/how-to/"} + - {"from": "/resources/workbooks/federal-awards/", "to": "/audit-resources/sf-sac/federal-awards/"} + - {"from": "/resources/workbooks/notes-to-sefa/", "to": "/audit-resources/sf-sac/notes-to-sefa/"} + - {"from": "/resources/workbooks/federal-awards-audit-findings/", "to": "/audit-resources/sf-sac/federal-awards-audit-findings/"} + - {"from": "/resources/workbooks/federal-awards-audit-findings-text/", "to": "/audit-resources/sf-sac/federal-awards-audit-findings-text/"} + - {"from": "/resources/workbooks/corrective-action-plan/", "to": "/audit-resources/sf-sac/corrective-action-plan/"} + - {"from": "/resources/workbooks/additional-ueis-workbook/", "to": "/audit-resources/sf-sac/additional-ueis-workbook/"} + - {"from": "/resources/workbooks/secondary-auditors-workbook/", "to": "/audit-resources/sf-sac/secondary-auditors-workbook/"} + - {"from": "/resources/workbooks/additional-eins-workbook/", "to": "/audit-resources/sf-sac/additional-eins-workbook/"} +# Info + - {"from": "/resources/instructions/user-access/", "to": "/audit-resources/user-access/"} + - {"from": "/info/updates/", "to": "/updates/"} + - {"from": "/info/updates/archive/", "to": "/updates/archive/"} + - {"from": "/info/announcements/", "to": "/omb/"} +permalink: "{{ redirect.from }}" +layout: redirect.njk +--- \ No newline at end of file From 4a8321accb331747884fc4af987abd41ccdf8562 Mon Sep 17 00:00:00 2001 From: James Person Date: Wed, 6 Mar 2024 10:36:56 -0500 Subject: [PATCH 51/79] Include usa-banner up top --- src/_includes/layout.njk | 1 + 1 file changed, 1 insertion(+) diff --git a/src/_includes/layout.njk b/src/_includes/layout.njk index a9c6ed07..40a28f49 100644 --- a/src/_includes/layout.njk +++ b/src/_includes/layout.njk @@ -14,6 +14,7 @@ + {% include './components/usa-banner.njk' %} {% include 'header.njk' %}
{{ content | safe }} From 0a8db93ea8af90f69761a10ae9ed4b44d3ca92ef Mon Sep 17 00:00:00 2001 From: James Person Date: Wed, 6 Mar 2024 14:03:04 -0500 Subject: [PATCH 52/79] Minor content changes --- src/_collections/resources/api/09-tribal.md | 2 +- src/_collections/resources/search/03-tribal-audits.md | 2 +- src/search-resources/index.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/_collections/resources/api/09-tribal.md b/src/_collections/resources/api/09-tribal.md index efdd72ad..6134cb2d 100644 --- a/src/_collections/resources/api/09-tribal.md +++ b/src/_collections/resources/api/09-tribal.md @@ -1,6 +1,6 @@ --- tags: resources, api header: Tribal data access -description: Access data and Single Audit Reports via the API that Tribes and Tribal Organizations have chosen to suppress. +description: Use the API to access data and Single Audit Reports that Tribes and Tribal Organizations have chosen to suppress. link: 'api/tribal' --- \ No newline at end of file diff --git a/src/_collections/resources/search/03-tribal-audits.md b/src/_collections/resources/search/03-tribal-audits.md index b377a273..56df8ef4 100644 --- a/src/_collections/resources/search/03-tribal-audits.md +++ b/src/_collections/resources/search/03-tribal-audits.md @@ -1,6 +1,6 @@ --- tags: resources, search header: Tribal audits -description: Accessing some audit data belonging to Tribes and Tribal entities requires special permissions. These instructions guide you through how to access these audits. +description: Accessing audit data belonging to Tribes and Tribal entities sometimes requires special permissions. These instructions guide you through how to access these audits. link: 'search-resources/tribal/' --- \ No newline at end of file diff --git a/src/search-resources/index.md b/src/search-resources/index.md index 8ef72030..d58916ab 100644 --- a/src/search-resources/index.md +++ b/src/search-resources/index.md @@ -9,4 +9,4 @@ meta: description: Find resources and tools for making the most of your search for single audit submissions stored by the Federal Audit Clearinghouse. --- -The Federal Audit Clearinghouse is the place to search for single audit submissions. You can search for audits for the current fiscal year or going back to 2016. The resources below will help you make the most of your search. +The Federal Audit Clearinghouse is the place to search for single audit submissions. You can search audits for the current fiscal year or back to 2016. The resources below will help you make the most of your search. From 152e3881efee1d85a4412439dc91c96510797304 Mon Sep 17 00:00:00 2001 From: James Person Date: Tue, 12 Mar 2024 10:16:49 -0400 Subject: [PATCH 53/79] A test commit for baseURL with redirects --- src/_includes/redirect.njk | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/_includes/redirect.njk b/src/_includes/redirect.njk index 9616b7b2..4c962f5e 100644 --- a/src/_includes/redirect.njk +++ b/src/_includes/redirect.njk @@ -2,7 +2,11 @@ - + {% if "https" in redirect.to %} + + {% else %} + + {% endif %} You are being redirected to {{ redirect.to }} From 238315d4a28e995fea9471fac7f079a6984c129a Mon Sep 17 00:00:00 2001 From: James Person Date: Tue, 12 Mar 2024 10:45:18 -0400 Subject: [PATCH 54/79] Redirect on baseURL if it's there. --- src/_includes/redirect.njk | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/_includes/redirect.njk b/src/_includes/redirect.njk index 4c962f5e..bc49273b 100644 --- a/src/_includes/redirect.njk +++ b/src/_includes/redirect.njk @@ -2,7 +2,7 @@ - {% if "https" in redirect.to %} + {% if "https" in config.baseUrl %} {% else %} From 320930e06b445a23b9ac8167df2852b875fee167 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Tue, 12 Mar 2024 10:46:41 -0400 Subject: [PATCH 55/79] fixing broken links --- src/_collections/updates/2023-09-08-acee.md | 2 +- src/omb/index.md | 2 +- src/updates/index.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/_collections/updates/2023-09-08-acee.md b/src/_collections/updates/2023-09-08-acee.md index 805e364a..4b5a9250 100644 --- a/src/_collections/updates/2023-09-08-acee.md +++ b/src/_collections/updates/2023-09-08-acee.md @@ -2,4 +2,4 @@ tags: submitters date: "2023-09-08" --- -At this time, the FAC is not accepting submissions for Alternative Compliance Examination Engagements (ACEE). [The Office of Management and Budget (OMB) has granted an automatic extension for these entities for Audit Year 2023]({{ config.baseUrl }}info/announcements). \ No newline at end of file +At this time, the FAC is not accepting submissions for Alternative Compliance Examination Engagements (ACEE). [The Office of Management and Budget (OMB) has granted an automatic extension for these entities for Audit Year 2023]({{ config.baseUrl }}omb). \ No newline at end of file diff --git a/src/omb/index.md b/src/omb/index.md index c8df893d..c4c469be 100644 --- a/src/omb/index.md +++ b/src/omb/index.md @@ -8,7 +8,7 @@ meta: # OMB Announcements -The Office of Management and Budget (OMB) sets the policy for single audit submissions and their deadlines. The announcements below are in effect; for historic decisions, view [our archive]({{ config.baseUrl }}info/announcements/archive). +The Office of Management and Budget (OMB) sets the policy for single audit submissions and their deadlines. The announcements below are in effect; for historic decisions, view [our archive]({{ config.baseUrl }}omb/archive).
Date: Tue, 12 Mar 2024 10:53:50 -0400 Subject: [PATCH 56/79] removing tribal audits from nav --- src/_data/global.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/_data/global.yaml b/src/_data/global.yaml index 5a2feb98..c8dd73eb 100644 --- a/src/_data/global.yaml +++ b/src/_data/global.yaml @@ -10,9 +10,6 @@ navigation: - text: Search resources href: 'search-resources' - text: Developer resources - href: 'api' - - text: Tribal audits - href: 'search-resources/tribal' - text: Audit submission id: audits links: From 4fb59d33b1cba64aedcc8ffd8c298ad5ac26978b Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Tue, 12 Mar 2024 10:56:12 -0400 Subject: [PATCH 57/79] updating nav --- src/_data/global.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/_data/global.yaml b/src/_data/global.yaml index c8dd73eb..3a1f9bda 100644 --- a/src/_data/global.yaml +++ b/src/_data/global.yaml @@ -30,5 +30,4 @@ navigation: - text: Uniform guidance href: 'uniform-guidance' - text: Burden statement - href: 'audit-resources/burden-statement' - + href: 'audit-resources/burden-statement' \ No newline at end of file From e7ef98ec62480fe82df6893d7fff1e3f4a2d6296 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Tue, 12 Mar 2024 11:04:54 -0400 Subject: [PATCH 58/79] fixing nav --- src/_data/global.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/src/_data/global.yaml b/src/_data/global.yaml index 3a1f9bda..74c5e6ac 100644 --- a/src/_data/global.yaml +++ b/src/_data/global.yaml @@ -10,6 +10,7 @@ navigation: - text: Search resources href: 'search-resources' - text: Developer resources + href: 'api' - text: Audit submission id: audits links: From 3e7f76cee7ab808671d5de9dbe8270d517d560dc Mon Sep 17 00:00:00 2001 From: James Person Date: Tue, 12 Mar 2024 11:13:58 -0400 Subject: [PATCH 59/79] Quick test of redirects without a leading slash --- src/_includes/redirect.njk | 8 ++------ src/redirects.md | 2 +- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/src/_includes/redirect.njk b/src/_includes/redirect.njk index bc49273b..5352e640 100644 --- a/src/_includes/redirect.njk +++ b/src/_includes/redirect.njk @@ -2,13 +2,9 @@ - {% if "https" in config.baseUrl %} - - {% else %} - - {% endif %} + - You are being redirected to {{ redirect.to }} + You are being redirected to {{ config.baseUrl }}{{ redirect.to }} \ No newline at end of file diff --git a/src/redirects.md b/src/redirects.md index d9dceef6..27759821 100644 --- a/src/redirects.md +++ b/src/redirects.md @@ -18,7 +18,7 @@ redirects: - {"from": "/data/resources/", "to": "/search-resources/"} - {"from": "/data/tribal/", "to": "/search-resources/tribal/"} # API pages - - {"from": "/developers/", "to": "/api/"} + - {"from": "/developers/", "to": "api/"} - {"from": "/developers/dictionary/", "to": "/api/dictionary/"} - {"from": "/developers/getting-started/", "to": "/api/getting-started/"} - {"from": "/developers/rollups/", "to": "/api/rollup/"} From 7f1dee8c11ae47c64d04784c27e7892227e00558 Mon Sep 17 00:00:00 2001 From: James Person Date: Tue, 12 Mar 2024 11:19:34 -0400 Subject: [PATCH 60/79] Remove all leading slashes from redirects. Comments. --- src/_includes/resources_page.njk | 3 ++- src/redirects.md | 46 +++++++++++++++++--------------- 2 files changed, 26 insertions(+), 23 deletions(-) diff --git a/src/_includes/resources_page.njk b/src/_includes/resources_page.njk index c611e022..4ab9bef2 100644 --- a/src/_includes/resources_page.njk +++ b/src/_includes/resources_page.njk @@ -8,7 +8,8 @@ layout: layout.njk
{{content | safe}}
- {# Cards are generated from the current pages 'collectionName'. To add more cards, navigate to collections and ensure the #} + {# Cards are generated from the current pages 'collectionName'. + To add more cards, navigate to collections and ensure the tags match up with the pages collectionName. #}
    {% set indexList = collections[collectionName] %} {% for item in indexList %} diff --git a/src/redirects.md b/src/redirects.md index 27759821..99fa22f7 100644 --- a/src/redirects.md +++ b/src/redirects.md @@ -14,33 +14,35 @@ pagination: size: 1 alias: redirect redirects: +# "from" - The place we want to overwrite with a redirect page. Leading slashes are necessary to identify the permalink. +# "to" - The place we want the redirect to go. No leading slashes, so it can play nice with different baseUrl's (local, prod, federalist). # Search resources - - {"from": "/data/resources/", "to": "/search-resources/"} - - {"from": "/data/tribal/", "to": "/search-resources/tribal/"} + - {"from": "/data/resources/", "to": "search-resources/"} + - {"from": "/data/tribal/", "to": "search-resources/tribal/"} # API pages - {"from": "/developers/", "to": "api/"} - - {"from": "/developers/dictionary/", "to": "/api/dictionary/"} - - {"from": "/developers/getting-started/", "to": "/api/getting-started/"} - - {"from": "/developers/rollups/", "to": "/api/rollup/"} - - {"from": "/developers/differences/", "to": "/api/differences/"} - - {"from": "/developers/api-versioning/", "to": "/api/versioning/"} - - {"from": "/developers/terms/", "to": "/api/terms/"} + - {"from": "/developers/dictionary/", "to": "api/dictionary/"} + - {"from": "/developers/getting-started/", "to": "api/getting-started/"} + - {"from": "/developers/rollups/", "to": "api/rollup/"} + - {"from": "/developers/differences/", "to": "api/differences/"} + - {"from": "/developers/api-versioning/", "to": "api/versioning/"} + - {"from": "/developers/terms/", "to": "api/terms/"} # Audit resources - - {"from": "/audits/", "to": "/audit-resources/"} - - {"from": "/resources/instructions/", "to": "/audit-resources/how-to/"} - - {"from": "/resources/workbooks/federal-awards/", "to": "/audit-resources/sf-sac/federal-awards/"} - - {"from": "/resources/workbooks/notes-to-sefa/", "to": "/audit-resources/sf-sac/notes-to-sefa/"} - - {"from": "/resources/workbooks/federal-awards-audit-findings/", "to": "/audit-resources/sf-sac/federal-awards-audit-findings/"} - - {"from": "/resources/workbooks/federal-awards-audit-findings-text/", "to": "/audit-resources/sf-sac/federal-awards-audit-findings-text/"} - - {"from": "/resources/workbooks/corrective-action-plan/", "to": "/audit-resources/sf-sac/corrective-action-plan/"} - - {"from": "/resources/workbooks/additional-ueis-workbook/", "to": "/audit-resources/sf-sac/additional-ueis-workbook/"} - - {"from": "/resources/workbooks/secondary-auditors-workbook/", "to": "/audit-resources/sf-sac/secondary-auditors-workbook/"} - - {"from": "/resources/workbooks/additional-eins-workbook/", "to": "/audit-resources/sf-sac/additional-eins-workbook/"} + - {"from": "/audits/", "to": "audit-resources/"} + - {"from": "/resources/instructions/", "to": "audit-resources/how-to/"} + - {"from": "/resources/workbooks/federal-awards/", "to": "audit-resources/sf-sac/federal-awards/"} + - {"from": "/resources/workbooks/notes-to-sefa/", "to": "audit-resources/sf-sac/notes-to-sefa/"} + - {"from": "/resources/workbooks/federal-awards-audit-findings/", "to": "audit-resources/sf-sac/federal-awards-audit-findings/"} + - {"from": "/resources/workbooks/federal-awards-audit-findings-text/", "to": "audit-resources/sf-sac/federal-awards-audit-findings-text/"} + - {"from": "/resources/workbooks/corrective-action-plan/", "to": "audit-resources/sf-sac/corrective-action-plan/"} + - {"from": "/resources/workbooks/additional-ueis-workbook/", "to": "audit-resources/sf-sac/additional-ueis-workbook/"} + - {"from": "/resources/workbooks/secondary-auditors-workbook/", "to": "audit-resources/sf-sac/secondary-auditors-workbook/"} + - {"from": "/resources/workbooks/additional-eins-workbook/", "to": "audit-resources/sf-sac/additional-eins-workbook/"} # Info - - {"from": "/resources/instructions/user-access/", "to": "/audit-resources/user-access/"} - - {"from": "/info/updates/", "to": "/updates/"} - - {"from": "/info/updates/archive/", "to": "/updates/archive/"} - - {"from": "/info/announcements/", "to": "/omb/"} + - {"from": "/resources/instructions/user-access/", "to": "audit-resources/user-access/"} + - {"from": "/info/updates/", "to": "updates/"} + - {"from": "/info/updates/archive/", "to": "updates/archive/"} + - {"from": "/info/announcements/", "to": "omb/"} permalink: "{{ redirect.from }}" layout: redirect.njk --- \ No newline at end of file From 70ee43db93ff7e67c3e07c45848cff1fbfc445fb Mon Sep 17 00:00:00 2001 From: James Person Date: Fri, 15 Mar 2024 19:06:58 -0400 Subject: [PATCH 61/79] Homepage - desktop:flex-row the cards --- src/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/index.md b/src/index.md index c3aac960..9e393912 100644 --- a/src/index.md +++ b/src/index.md @@ -29,7 +29,7 @@ include_survey: true

    I want to

-
    +
    • Date: Fri, 15 Mar 2024 19:11:02 -0400 Subject: [PATCH 62/79] Homepage - 'or' margins for mobile --- src/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/index.md b/src/index.md index 9e393912..f629313b 100644 --- a/src/index.md +++ b/src/index.md @@ -41,7 +41,7 @@ include_survey: true
      • -

      or

      +

      or

    • Date: Mon, 18 Mar 2024 16:03:46 -0400 Subject: [PATCH 63/79] adding site status page --- src/_data/global.yaml | 2 ++ src/status.md | 17 +++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 src/status.md diff --git a/src/_data/global.yaml b/src/_data/global.yaml index 74c5e6ac..43134321 100644 --- a/src/_data/global.yaml +++ b/src/_data/global.yaml @@ -23,6 +23,8 @@ navigation: href: 'updates' - text: OMB announcements href: 'omb' + - text: System status + href: 'status' - text: Policy & Compliance id: policy links: diff --git a/src/status.md b/src/status.md new file mode 100644 index 00000000..9aa3b0e3 --- /dev/null +++ b/src/status.md @@ -0,0 +1,17 @@ +--- +layout: home.njk +title: FAC system status +meta: + name: FAC system status + description: Track the operating status of the FAC, both for audit submission and search. +--- + +# March 18, 2024 + +**Audit search is currently limited to UEI-only.** You can search your UEI to confirm your audit submission is complete. The PDF report will still be available for download but summary report workbooks won't. + +## Issue background +In mid-February, GSA completed the migration of historical data from the Census Bureau. This increased the amount of data in the GSA system exponentially and slowed down search performance. +Our team has released multiple patches to stabilize search performance since then but have been unable to do so consistently. For this reason, we've decided to reduce search to UEI-only while we focus on building new search tables instead of one-off bug fixes. + +We're working as quickly and efficiently as possible to return full search functionality to our users as soon as we can. Thank you for your patience. \ No newline at end of file From 7f694f79ba7c821e96876416f4e2661e1e49461c Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 18 Mar 2024 16:07:10 -0400 Subject: [PATCH 64/79] adding alert banner --- src/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/index.md b/src/index.md index f629313b..21ebc1ac 100644 --- a/src/index.md +++ b/src/index.md @@ -6,6 +6,11 @@ meta: description: The Federal Audit Clearinghouse is the home of the single audit process for the federal government awards system. include_survey: true --- +
      +
      + TEST SITE: This is a test site. Do not begin audit submissions. +
      +
      From d8e62f29ce4792bb2884b1e5a101da559c3651b1 Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 18 Mar 2024 16:10:59 -0400 Subject: [PATCH 65/79] banner take 2 --- src/index.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/src/index.md b/src/index.md index 21ebc1ac..7a68bb7b 100644 --- a/src/index.md +++ b/src/index.md @@ -6,12 +6,6 @@ meta: description: The Federal Audit Clearinghouse is the home of the single audit process for the federal government awards system. include_survey: true --- -
      -
      - TEST SITE: This is a test site. Do not begin audit submissions. -
      -
      -
      {# Title #} From 1dde91bcc9310371ad2bebd6ae352ecde561d36e Mon Sep 17 00:00:00 2001 From: Laura Herring Date: Mon, 18 Mar 2024 16:20:38 -0400 Subject: [PATCH 66/79] banner again --- src/_includes/header.njk | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/_includes/header.njk b/src/_includes/header.njk index c94f3128..5161ab1c 100644 --- a/src/_includes/header.njk +++ b/src/_includes/header.njk @@ -1,5 +1,12 @@
      + +
      +
      + TEST SITE: This is a test site. Do not begin audit submissions. +
      +
      +