Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cdcgov/nedss-systemadminguide

https://github.com/cdcgov/nedss-systemadminguide

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Basic Info
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created 12 months ago · Last pushed 10 months ago
Metadata Files
Readme Contributing License Code of conduct Support

README.md

NBS System Admin Guide User Guide

Quick Guide

GitHub Pages URL https://cdcgov.github.io/NEDSS-SystemAdminGuide/

| Action | Location | |----------------------------|---------------------------------------| | Add draft docs | _guide_preview/*.md | | View a draft page | /guide_preview/<file_path>/. Example ../docs/1introduction/architectureandmicroservices.html -> ../guidepreview/1introduction/architectureand_microservices.html | | Previous release versions | Any branch naming with convention release-<version>, will be automatacally added under PREVIOUS VERSIONS section | | Access versioned docs | Located under PREVIOUS VERSIONS section |

Implementation

GitHub Pages hosts System Admin Guide site by serving static HTML, CSS, and JS directly from this repository (via GitHub Actions) .

Just the Docs is a Jekyll-based theme optimized for documentation sites, fully-compatible with GitHub Pages—providing menus, search, collections, and theming out-of-the-box .

GitHub Actions Workflow builds and deploys content through these steps:

  • Build main branch into site/. from docs directory and separately _guidepreview
  • Discover and build any release-* branches into previousversions//.
  • Upload and deploy everything via GitHub Pages.
  • Jekyll renders navigation, hides preview docs, and adds version management.

Draft & Preview Content

You can drop Markdown files into the _guide_preview/ directory to serve draft or preview documentation that is: - Rendered and available, but hidden from navigation and search. - Accessible only via direct URL (e.g. /guide_preview/my-file/).

Previous Versions

Branches starting with release- are automatically built and deployed under /previous_versions/<branch>/ via GitHub Actions.

Markdown & Configuration Sources

We use GitHub-Flavored Markdown (GFM) for tables, fenced code blocks, lists, etc.

Just the Docs theme renders pages according to _config.yml, supporting navigation, collections, syntax highlighting, and more .

Building and Previewing Site locally

Assuming Jekyll and Bundler are installed on your computer:

  1. Change your working directory to the root directory of your site.
  2. Run bundle install.
  3. Run bundle exec jekyll serve to build your site and preview it at localhost:4000. The built site is stored in the directory _site.

Supporting Links

Owner

  • Name: Centers for Disease Control and Prevention
  • Login: CDCgov
  • Kind: organization
  • Email: data@cdc.gov
  • Location: Atlanta, GA

CDC's collaborative software projects to protect America from health, safety, and security threats, both foreign and in the U.S.

GitHub Events

Total
  • Delete event: 6
  • Member event: 4
  • Push event: 133
  • Pull request review comment event: 4
  • Pull request review event: 14
  • Pull request event: 15
  • Create event: 15
Last Year
  • Delete event: 6
  • Member event: 4
  • Push event: 133
  • Pull request review comment event: 4
  • Pull request review event: 14
  • Pull request event: 15
  • Create event: 15

Dependencies

.github/workflows/jekyll.yml actions
  • actions/checkout v4 composite
  • actions/configure-pages v5 composite
  • actions/deploy-pages v4 composite
  • actions/upload-pages-artifact v3 composite
  • ruby/setup-ruby 4a9ddd6f338a97768b8006bf671dfbad383215f4 composite
Gemfile rubygems
  • jekyll ~> 4.4.1
  • just-the-docs = 0.10.1
Gemfile.lock rubygems
  • addressable 2.8.7
  • base64 0.2.0
  • bigdecimal 3.1.9
  • bundler 2.5.9
  • colorator 1.1.0
  • concurrent-ruby 1.3.5
  • csv 3.3.2
  • em-websocket 0.5.3
  • eventmachine 1.2.7
  • ffi 1.17.1
  • forwardable-extended 2.6.0
  • google-protobuf 4.29.3
  • http_parser.rb 0.8.0
  • i18n 1.14.7
  • jekyll 4.4.1
  • jekyll-include-cache 0.2.1
  • jekyll-sass-converter 3.0.0
  • jekyll-seo-tag 2.8.0
  • jekyll-watch 2.2.1
  • json 2.9.1
  • just-the-docs 0.10.1
  • kramdown 2.5.1
  • kramdown-parser-gfm 1.1.0
  • liquid 4.0.4
  • listen 3.9.0
  • mercenary 0.4.0
  • pathutil 0.16.2
  • public_suffix 6.0.1
  • rake 13.2.1
  • rb-fsevent 0.11.2
  • rb-inotify 0.11.1
  • rexml 3.4.0
  • rouge 4.5.1
  • safe_yaml 1.0.5
  • sass-embedded 1.83.4
  • terminal-table 3.0.2
  • unicode-display_width 2.6.0
  • webrick 1.9.1