Skip to content

Commit

Permalink
FI-2538: Create new docs 404 page (#486)
Browse files Browse the repository at this point in the history
* delete docs

* copy over docs files

* remove search logic

* revert markdown settings

* update favicon path

* update wording

* Update docs/404.html

Co-authored-by: Rob Scanlon <robscanlon@gmail.com>

* update link

---------

Co-authored-by: Alyssa Wang <awang@mitre.org>
Co-authored-by: Rob Scanlon <robscanlon@gmail.com>
  • Loading branch information
3 people authored Apr 23, 2024
1 parent 030468a commit 038d0e2
Show file tree
Hide file tree
Showing 43 changed files with 4,241 additions and 3,053 deletions.
14 changes: 9 additions & 5 deletions docs/404.html
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
---
layout: default
layout: base
---

<style type="text/css" media="screen">
.container {
margin: 10px auto;
max-width: 600px;
text-align: center;
height: 100%;
}

h1 {
margin: 30px 0;
margin-top: 20%;
font-size: 4em;
line-height: 1;
letter-spacing: -1px;
}
</style>

<div class="container">
<h1>404</h1>
<h1>We moved!</h1>

<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>
<p><strong> This page no longer exists.</strong></p>
<p>You've reached an outdated version of the Inferno Documentation site. Head to the <a
href="https://inferno-framework.github.io/docs/">new site</a> for updated documentation.</p>
</div>
3 changes: 0 additions & 3 deletions docs/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ source 'https://rubygems.org'
# Happy Jekylling!
# gem "jekyll", "~> 3.6.3"

# This is the default theme for new Jekyll sites. You may change this to anything you like.
gem 'just-the-docs', '~> 0.3.3'

# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins
Expand Down
60 changes: 25 additions & 35 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,29 @@ GEM
minitest (~> 5.1)
tzinfo (~> 1.1)
zeitwerk (~> 2.2, >= 2.2.2)
addressable (2.8.1)
addressable (2.8.6)
public_suffix (>= 2.0.2, < 6.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.11.1)
colorator (1.1.0)
commonmarker (0.23.10)
concurrent-ruby (1.2.2)
dnsruby (1.61.9)
simpleidn (~> 0.1)
concurrent-ruby (1.2.3)
dnsruby (1.72.0)
simpleidn (~> 0.2.1)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
ethon (0.15.0)
ethon (0.16.0)
ffi (>= 1.15.0)
eventmachine (1.2.7)
execjs (2.8.1)
faraday (2.6.0)
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.1)
ffi (1.15.5)
execjs (2.9.1)
faraday (2.9.0)
faraday-net_http (>= 2.0, < 3.2)
faraday-net_http (3.1.0)
net-http
ffi (1.16.3)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (227)
Expand Down Expand Up @@ -197,44 +197,36 @@ GEM
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0, < 5.0)
just-the-docs (0.3.3)
jekyll (>= 3.8.5)
jekyll-seo-tag (~> 2.0)
rake (>= 12.3.1, < 13.1.0)
kramdown (2.3.2)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.7.1)
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.18.0)
nokogiri (1.14.3-arm64-darwin)
racc (~> 1.4)
nokogiri (1.14.3-x86_64-darwin)
racc (~> 1.4)
nokogiri (1.14.3-x86_64-linux)
minitest (5.22.3)
net-http (0.4.1)
uri
nokogiri (1.16.4-arm64-darwin)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.7)
racc (1.6.2)
rake (13.0.6)
racc (1.7.3)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rexml (3.2.6)
rouge (3.26.0)
ruby2_keywords (0.0.5)
rubyzip (2.3.2)
safe_yaml (1.0.5)
sass (3.7.4)
Expand All @@ -250,27 +242,25 @@ GEM
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6)
typhoeus (1.4.0)
typhoeus (1.4.1)
ethon (>= 0.9.0)
tzinfo (1.2.11)
thread_safe (~> 0.1)
unf (0.1.4)
unf_ext
unf_ext (0.0.8.2)
unf_ext (0.0.9.1)
unicode-display_width (1.8.0)
webrick (1.7.0)
zeitwerk (2.6.7)
uri (0.13.0)
webrick (1.8.1)
zeitwerk (2.6.13)

PLATFORMS
arm64-darwin-21
x86_64-darwin-20
x86_64-linux
arm64-darwin-22

DEPENDENCIES
github-pages (~> 227)
just-the-docs (~> 0.3.3)
tzinfo-data
webrick (~> 1.7)

BUNDLED WITH
2.3.14
2.4.22
2 changes: 0 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ url: "https://inferno-framework.github.io" # the base hostname & protocol for yo

# Build settings
markdown: kramdown
remote_theme: pmarsceill/just-the-docs
# theme: just-the-docs

# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
Expand Down
14 changes: 14 additions & 0 deletions docs/_includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<footer class="py-4 mt-4 bg-light">
<div class="container-fluid">
<div class="row">
<div class="col-sm-6">
<h4 data-toc-skip>Contact Us</h4>
<p>The fastest way to reach the Inferno team is via the <a
href="https://chat.fhir.org/#narrow/stream/179309-inferno">Inferno Zulip stream</a>.</p>
<p>You can also e-mail the <a href="mailto:inferno@groups.mitre.org">Inferno Development Team</a>.</p>
</div>
<div class="col-sm-6">
</div>
</div>
</div>
</footer>
48 changes: 48 additions & 0 deletions docs/_includes/menubar.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<nav class="header-nav navbar navbar-expand-lg navbar-light navbar-custom">
<div class="container-fluid">
<a class="navbar-brand" href="https://inferno-framework.github.io" aria-label="Home">
<img src="{{ site.baseurl }}/assets/icon_logo.png" alt="Logo" width="46px" height="50px">
<span class="visually-hidden">Inferno Framework Homepage</span>
</a>
<p class="h3 d-lg-none">Inferno Framework</p>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav"
aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarNav">
<div class="search-container">
<div class="input-group">
<span class="input-group-text border-right-0 text-muted" id="search-addon">
<i class="fas fa-search"></i>
</span>
<input type="search" disabled class="form-control border-left-0 pl-0 shadow-none"
placeholder="Search Inferno Documentation" aria-label="Search" aria-describedby="search-addon"
id="search-input">
</div>
<div id="search-results" class="search-results"></div>
</div>
<ul class="navbar-nav">
<li class="nav-item">
<a class="nav-link{% if page.section == 'about' %} active{% endif %} align-middle" style="display: inline"
href="https://inferno-framework.github.io/about">About</a>
</li>
<li class="nav-item">
<a class="nav-link{% if page.section == 'docs' %} active{% endif %}"
href="https://inferno-framework.github.io/docs">Documentation</a>
</li>
<li class="nav-item">
<a class="nav-link{% if page.section == 'community' %} active{% endif %}"
href="https://inferno-framework.github.io/community">Community</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.section == 'news' %} active{% endif %}"
href="https://inferno-framework.github.io/news">News</a>
</li>
</ul>
<a href="https://github.com/inferno-framework" target="_blank" rel="noopener noreferrer"
class="ms-2 d-flex align-items-center github-menu" style="text-decoration:none">
<i class="fab fa-github fa-lg"></i><span class="visually-hidden">Inferno Framework on GitHub</span>
</a>
</div>
</div>
</nav>
44 changes: 44 additions & 0 deletions docs/_layouts/base.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!doctype html>
<html lang="en" class="h-100">

<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="icon" href="{{ site.baseurl }}/assets/favicon.ico" type="image/x-icon">

<!-- Bootstrap CSS -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/css/bootstrap.min.css">
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet">
<link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.7.2/font/bootstrap-icons.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.0/css/all.min.css">
<link href="{{ site.baseurl }}/assets/prism.css" rel="stylesheet" />

<link rel="stylesheet" href="{{ site.baseurl }}/assets/common.css">

<title>Inferno Framework - {{ page.title }}</title>
</head>

<body data-spy="scroll" data-target="#toc" class="d-flex flex-column h-100">
<a href="#content" class="visually-hidden-focusable">Skip to main content</a>

{% include menubar.html %}

{{ content }}

{% include footer.html %}

<div class="search-overlay"></div>

<!-- jQuery first, then Popper.js, then Bootstrap JS -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/2.9.3/umd/popper.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.min.js"></script>
<script src="{{ site.baseurl }}/assets/lunr-2.3.9.js"></script>
<script src="{{ site.baseurl }}/assets/bootstrap-toc-101.min.js"></script>
<script src="{{ site.baseurl }}/assets/common.js"></script>
<script src="{{ site.baseurl }}/assets/prism.js"></script>

</body>

</html>
9 changes: 0 additions & 9 deletions docs/_sass/custom/custom.scss

This file was deleted.

46 changes: 0 additions & 46 deletions docs/advanced-test-features/configuration-checks.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/advanced-test-features/index.md

This file was deleted.

Loading

0 comments on commit 038d0e2

Please sign in to comment.