MkDocs configuration and content for info/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

186 lines
7.9 KiB

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Welcome to the COSI Info and Documentation server! - COSI Info/</title>
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/all.css">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/v4-shims.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack.min.css">
<link href='//rsms.me/inter/inter.css' rel='stylesheet' type='text/css'>
<link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,600,700&subset=latin-ext,latin' rel='stylesheet' type='text/css'>
<link href="css/bootstrap-custom.min.css" rel="stylesheet">
<link href="css/base.min.css" rel="stylesheet">
<link href="css/cinder.min.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://cdn.jsdelivr.net/npm/html5shiv@3.7.3/dist/html5shiv.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/respond.js@1.4.2/dest/respond.min.js"></script>
<![endif]-->
</head>
<body class="homepage" >
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Main title -->
<a class="navbar-brand" href=".">COSI Info/</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fas fa-search"></i> Search
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="first-level active"><a href="#welcome-to-the-cosi-info-and-documentation-server">Welcome to the COSI Info and Documentation server!</a></li>
<li class="second-level"><a href="#contributing-to-info">Contributing to info/</a></li>
<li class="third-level"><a href="#how-to-contribute">How to contribute:</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="welcome-to-the-cosi-info-and-documentation-server">Welcome to the COSI Info and Documentation server!</h1>
<p>Information about infrastructure, services and about the labs in general can be found throughout the site. </p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>As this site is under construction, some information may not be present. The most up to date documentation can be found on our <a href="https://gitea.cosi.clarkson.edu">Gitea instance</a>. Older documentation may be found on the <a href="http://docs.cosi.clarkson.edu">older documentation server</a>.</p>
</div>
<h2 id="contributing-to-info">Contributing to info/</h2>
<p>COSI is a living-learning community. In order to help lab members (past, present and future) maintain the community, it becomes a necessity to document what each service is and how it works.Contributing to info/ is an ideal way of doing so as it is accessible to everyone from their web browser. </p>
<h3 id="how-to-contribute">How to contribute:</h3>
<p>To contribute to info/, make sure you have an LDAP account on the COSI network. If you do not have one, contact an available sysadmin and they will create one for you. </p>
<p>In addition, you will need to install <code>mkdocs</code> on your system. Refer to <a href="https://www.mkdocs.org/#installation">https://www.mkdocs.org/#installation</a> for installation instructions.</p>
<p>Once you have an LDAP account, clone down the <a href="https://gitea.cslabs.clarkson.edu/COSI_Sysadmins/info-slash">info-slash repository</a> and make modifications to your local copy. You can preview your changes by running <code>mkdocs serve</code> and then viewing <a href="localhost:8000"><code>localhost:8000</code></a> in your browser. Commit and push your changes to have them be saved to the repository. To deploy your changes, run <code>mkdocs gh-deploy</code> and your changes will appear on info/ within 10 minutes. </p></div>
</div>
<footer class="col-md-12 text-center">
<hr>
<p>
<small>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</small>
</p>
</footer>
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
<script src="js/bootstrap-3.0.3.min.js"></script>
<script>var base_url = "."</script>
<script src="js/base.js"></script>
<script src="search/main.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal">
<span aria-hidden="true">&times;</span>
<span class="sr-only">Close</span>
</button>
<h4 class="modal-title" id="searchModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form>
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>
<!--
MkDocs version : 1.1.2
Build Date UTC : 2020-05-18 20:34:35.594223+00:00
-->