From 413d2ee932faa4e0855a7c32bd89ef2eb9c3864d Mon Sep 17 00:00:00 2001 From: Andrew Duthie Date: Fri, 17 Jan 2025 13:38:46 -0500 Subject: [PATCH] Add "Types of Documentation" article --- _articles/types-of-documentation.md | 69 +++++++++++++++++++++++++++++ assets/scss/main.css.scss | 3 +- 2 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 _articles/types-of-documentation.md diff --git a/_articles/types-of-documentation.md b/_articles/types-of-documentation.md new file mode 100644 index 00000000..773e5369 --- /dev/null +++ b/_articles/types-of-documentation.md @@ -0,0 +1,69 @@ +--- +title: Types of Documentation +description: An overview of the different types of documentation resources and where to find them +layout: article +category: Handbook +--- + +While this handbook covers topics relevant for all of the Login.gov team, it's not the only place +that you can expect to find documentation resources. + +This article outlines the different locations for documentation, and what content you should expect +to find in each. + +## [Login.gov Public Handbook](https://handbook.login.gov/) + +- Contains content relevant for the entire Login.gov program which is suitable to share with the + general public (see [_Sensitive Information_](https://handbook.login.gov/articles/contributing.html#sensitive-information)) +- Anyone can and should contribute, but content is written in [Markdown](https://en.wikipedia.org/wiki/Markdown) + and therefore requires some understanding of Markdown syntax +- Content is changed through pull requests in [the GitHub repository](https://github.com/GSA-TTS/identity-handbook), + which requires some understanding of Git, and requires an approving peer review +- Content is intended to be highly discoverable using website search functionality + +## [Login.gov Internal Handbook](https://lg-public.pages.production.gitlab.login.gov/identity-internal-handbook/) + +- Contains content relevant for the entire Login.gov program which is not suitable to share with the + general public (see [_Sensitive Information_](https://handbook.login.gov/articles/contributing.html#sensitive-information)) +- Anyone can and should contribute, but content is written in [Markdown](https://en.wikipedia.org/wiki/Markdown) + and therefore requires some understanding of Markdown syntax +- Content is changed through pull requests in [the GitHub repository](https://github.com/GSA-TTS/identity-handbook), + which requires some understanding of Git, and requires an approving peer review +- Content is intended to be highly discoverable using website search functionality + +## [Login.gov Google Drive](https://drive.google.com/drive/folders/0AJJ3eelM4E-NUk9PVA) + +- Contains both program-wide and team-specific content, organized into team or topic folders +- Content is generally less structured, and many documents are not expected to be kept up-to-date +- Google Docs offers an easy-to-use experience for writing content, and changes can be made without + an approvals process +- Content is discoverable through Google search, but it can be difficult to find timely and + program-specific documents without extensive use of filters + +## Login.gov Project Repositories + +- Contains project-specific content +- Content is written in [Markdown](https://en.wikipedia.org/wiki/Markdown) +- Content is readable through local copies of the project or in the GitHub/GitLab web interface, but + is not otherwise available at a website +- Content is changed through pull requests in [the GitHub repository](https://github.com/GSA-TTS/identity-handbook), + which requires some understanding of Git, and requires an approving peer review +- Content is discoverable through GitHub/GitLab search, which often produces low-quality results + +Examples: + +- [`18f/identity-idp` docs](https://github.com/18F/identity-idp/tree/main/docs) +- [`18f/identity-site` docs](https://github.com/GSA-TTS/identity-site/tree/main/docs) + +## GitLab Wikis + +- Contains team-specific or project-specific content +- Content changes can be made without an approvals process +- Wikis offer basic top-down (parent-child) structuring, without much flexibility for further + customization (e.g. ordering) +- Content is discoverable through GitHub/GitLab search, which often produces low-quality results + +Examples: + +- [DevOps Wiki](https://gitlab.login.gov/lg/identity-devops/-/wikis/home) +- [Team Katherine Wiki](https://gitlab.login.gov/groups/lg-teams/katherine/-/wikis/home) diff --git a/assets/scss/main.css.scss b/assets/scss/main.css.scss index da92c735..e5b75a0d 100644 --- a/assets/scss/main.css.scss +++ b/assets/scss/main.css.scss @@ -64,7 +64,8 @@ span { * Mimics private-eye lock emoji, but for GitLab repos * See https://github.com/18F/private-eye/blob/c08740d838eb2b95b318a916894c6cb6aae76e41/private-eye.js#L5 */ -a[href*="gitlab.login.gov/lg"] { +a[href*="gitlab.login.gov/lg"], +a[href*="gitlab.login.gov/groups/lg"] { & > strong::after, &::after { content: "\1F98A"; // 🦊