-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a040ab7
commit cc894cc
Showing
4 changed files
with
186 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # ============================================ | ||
| # Yaml records for redirects: for SEO mostly. | ||
| # Use: for managing 301 and 404 HTTP Status Codes | ||
| # For more info see: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes | ||
| # Developer: Clayton Barnette <[email protected]> | ||
| # | ||
| # File Name: _data/redirects.yml | ||
| # Used in: _includes/meta.html | ||
| # | ||
| # Redirects based on: | ||
| # - if the requested url matches a target url is listed in this file. | ||
| # - if a target match is found, user is redirected to destination listed. | ||
| # - if no match is found, user is send to requested page. | ||
| # | ||
| # Legend for redirects.yml structure | ||
| # - name: Title of destination page for referencing purposes (not used in redirect). | ||
| # request: requested page url after the domain name, example: /arch/lostpage. | ||
| # destination: page url after the domain name, example: /arch. | ||
| # date: [mm/dd/yyyy] date entry added to this file (not used in redirect). | ||
| # by: name or initials of person making entry. | ||
| # memo: note for record keeping, tracking, and reasoning. (not used in redirect). | ||
| # | ||
| # Note: Please remember to update the by:, date:, and memo: fields (the future you will thank you.) | ||
| # ========================================================== | ||
|
|
||
| - request: /approved-products-list-apl/ | ||
| destination: /fips201/ | ||
| name: FIPS 201 Approved Product List | ||
| date: 09/22/2023 | ||
| by: Clayton Barnette | ||
| memo: redirect for approved products list from playbooks site | ||
|
|
||
| # Template for new redirect record. | ||
| # - name: | ||
| # target: | ||
| # destination: | ||
| # date: | ||
| # by: | ||
| # memo: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| --- | ||
| # This section is called the front matter, remove the comments in your page template. | ||
| layout: page | ||
| collection: | ||
| # Collection Name Matching (look at config.yml for collection names) | ||
| title: Page title | ||
| # Example: ICAM Program Management Guide Introduction | ||
| permalink: Page Link | ||
| # Exmple: pm/ for landing pages choose a friendly permalink which is easy to share and remember | ||
| sticky_sidenav: true | ||
| sidenav: | ||
| # Look at _data/navigation.yml to create sidenav - Example: pm | ||
| # If you have headers in your doc, you can create a 2nd level navigation with subnav: | ||
|
|
||
| subnav: | ||
| - text: About this Repository | ||
| href: '#about-this-repository' | ||
| - text: Open an Issue | ||
| href: '#open-an-issue' | ||
| - text: Add a Page | ||
| href: '#add-a-page' | ||
| - text: Submit a Page | ||
| href: '#submit-a-page' | ||
| - text: Edit a Page | ||
| href: '#edit-a-page' | ||
| --- | ||
|
|
||
| Markdown is a simple way of writing and formatting. The formats can be used across many different platforms including for websites and documents. We created a sample template to help you with your page. | ||
|
|
||
| Review information on [how to contribute](https://playbooks.idmanagement.gov/contribute/) and how to [Add a New Page](https://playbooks.idmanagement.gov/contribute/#add-a-page). | ||
| If you want to learn more about markdown formatting: https://guides.github.com/features/mastering-markdown/ | ||
|
|
||
| You can copy and paste this template into a new page, and use the sample markdown. | ||
|
|
||
| You probably noticed this block at the top of the page. | ||
|
|
||
| layout: default | ||
| title: Title of the Page | ||
| permalink: /template/ | ||
|
|
||
| This block at the top of the page, called Front Matter, is used for website navigation when your guide is posted. Update the _Title of the Page_ and the _/template/_ | ||
|
|
||
| For more information on using different jekyll format or web design features: | ||
| - Federalist Jekyll - https://github.com/18F/federalist-uswds-jekyll/blob/main/README.md | ||
| - U.S. Web Design Standard - https://designsystem.digital.gov | ||
| - U.S. Web Design Standard Jekyll - https://github.com/18F/uswds-jekyll | ||
|
|
||
| ## Overview | ||
|
|
||
| To begin your guide, briefly state its purpose in one to two sentences for an Overview. You may include information on the intended audience, the intended outcome of the guide, and any other information that would help the user to understand the guide. | ||
|
|
||
| Then add a table of contents link for each section. For example: | ||
|
|
||
| * [Section 1 Title](#words-in-section1-title-separated-by-dashes) | ||
| * [Section 2 Title](#words-in-section2-title-separated-by-dashes) | ||
| * [Section 3 Title](#words-in-section3-title-separated-by-dashes) | ||
|
|
||
| We propose these sections for most guides: | ||
|
|
||
| ## Before You get Started | ||
| This section should tell the user what to prepare before starting a set of procedures. Explain any assumptions as bulleted lists. Clearly state the hardware and software requirements. | ||
|
|
||
| ## Procedure 1 | ||
| This section should tell the user how to achieve the goal. Explain all steps simply and don't try to recreate other resources that are easily found. Focus on the government and what can be unique when implementing or executing. | ||
|
|
||
| ## Procedure 2 | ||
| This section should tell the user how to achieve the goal. Explain all steps simply and don't try to recreate other resources that are easily found. Focus on the government and what can be unique when implementing or executing. | ||
|
|
||
| Here are sample markdown formats for you: | ||
|
|
||
| Headings use the hash sign with a space. | ||
|
|
||
| ## This Is a Second-Level Heading | ||
| ### This is a third-level heading | ||
| #### This is a fourth-level heading | ||
|
|
||
|
|
||
| ### Number List Items | ||
|
|
||
| 1. Step 1 of procedure. (Indent 2 spaces, enter a number, and add 1 space.) | ||
| 2. Step 2 of procedure. | ||
|
|
||
| ### Bullet List Items | ||
|
|
||
| * Bullet 1 (Indent 2 spaces, enter an asterisk, and add 1 space.) | ||
| * Bullet 2 | ||
|
|
||
| ### Bold and Italics | ||
|
|
||
| * Use double asterisks to bold a word: **bold**. | ||
| * Use underscores to create italics: _italics_. | ||
|
|
||
| ### Code Blocks | ||
|
|
||
| To create a code block, use spaces, backticks (```), and Returns in this order: | ||
|
|
||
| * 4 spaces plus 3 backticks (```) to start the code block | ||
| * A Return | ||
| * Type or paste in the code that the user needs to enter for a specific step | ||
| * Another Return | ||
| * 4 spaces plus 3 backticks to end the code block | ||
| * Another Return | ||
|
|
||
| For example: | ||
|
|
||
| ``` | ||
| Text within three backticks for code or command line samples | ||
| ``` | ||
|
|
||
| ### Code Comments | ||
|
|
||
| Code comments will be invisible in a webpage view, but others will be able to see the comment in GitHub Markdown. <!--For example, this code denotes a comment. It will not appear on a webpage but can be used as a reference for others viewing the file.--> | ||
|
|
||
| ### Images | ||
|
|
||
| To insert an image into your Page, upload the image file to the **/img/** folder in the GitHub repository. Then at the image insertion point in your page, add these formats to link to the image. | ||
|
|
||
| <img src="{{site.baseurl}}/img/imagename.png" alt="This is what I want a screen reader to say for 508 compliance"> | ||
|
|
||
| <img src="{{site.baseurl}}/img/imagename.png" alt="Text for an image aligned right goes here" align="right"> | ||
|
|
||
| <img src="{{site.baseurl}}/img/anotherimagename.png" alt="Text for another image aligned left goes here" align="left" width="25%"> | ||
|
|
||
|
|
||
| ### Links to Other Documents | ||
|
|
||
| To link to useful references, information: | ||
|
|
||
| [This is what I want my link to say]({{site.baseurl}}/insertlink/) | ||
|
|
||
| To link to a document, or to another website, you need to always open the link in a new window: | ||
|
|
||
| [This is what I want my link to say](https://www.governmentagency.gov){:target="_blank"}{:rel="noopener noreferrer"}. |