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.

352 lines
12 KiB

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <link rel="shortcut icon" href="img/favicon.ico">
  8. <title>Welcome to the COSI Info and Documentation server! - COSI Info/</title>
  9. <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/all.css">
  10. <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/v4-shims.css">
  11. <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack.min.css">
  12. <link href='//rsms.me/inter/inter.css' rel='stylesheet' type='text/css'>
  13. <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'>
  14. <link href="css/bootstrap-custom.min.css" rel="stylesheet">
  15. <link href="css/base.min.css" rel="stylesheet">
  16. <link href="css/cinder.min.css" rel="stylesheet">
  17. <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/styles/github.min.css">
  18. <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
  19. <!--[if lt IE 9]>
  20. <script src="https://cdn.jsdelivr.net/npm/html5shiv@3.7.3/dist/html5shiv.min.js"></script>
  21. <script src="https://cdn.jsdelivr.net/npm/respond.js@1.4.2/dest/respond.min.js"></script>
  22. <![endif]-->
  23. </head>
  24. <body class="homepage" >
  25. <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  26. <div class="container">
  27. <!-- Collapsed navigation -->
  28. <div class="navbar-header">
  29. <!-- Expander button -->
  30. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
  31. <span class="sr-only">Toggle navigation</span>
  32. <span class="icon-bar"></span>
  33. <span class="icon-bar"></span>
  34. <span class="icon-bar"></span>
  35. </button>
  36. <!-- Main title -->
  37. <a class="navbar-brand" href=".">COSI Info/</a>
  38. </div>
  39. <!-- Expanded navigation -->
  40. <div class="navbar-collapse collapse">
  41. <!-- Main navigation -->
  42. <ul class="nav navbar-nav">
  43. <li class="dropdown">
  44. <a href="#" class="dropdown-toggle" data-toggle="dropdown">Compute <b class="caret"></b></a>
  45. <ul class="dropdown-menu">
  46. <li >
  47. <a href="compute/hydra/">Hydra</a>
  48. </li>
  49. <li >
  50. <a href="compute/granddad/">Norm</a>
  51. </li>
  52. <li >
  53. <a href="compute/norm/">Tiamat</a>
  54. </li>
  55. <li >
  56. <a href="compute/tiamat/">Grand-Dad</a>
  57. </li>
  58. </ul>
  59. </li>
  60. <li class="dropdown">
  61. <a href="#" class="dropdown-toggle" data-toggle="dropdown">Networking <b class="caret"></b></a>
  62. <ul class="dropdown-menu">
  63. <li >
  64. <a href="network/ziltoid/">Ziltoid</a>
  65. </li>
  66. <li >
  67. <a href="network/atlas/">Atlas</a>
  68. </li>
  69. <li >
  70. <a href="network/talos/">Talos</a>
  71. </li>
  72. <li >
  73. <a href="network/unifi/">Unifi</a>
  74. </li>
  75. <li >
  76. <a href="network/voip/">Voip</a>
  77. </li>
  78. </ul>
  79. </li>
  80. <li class="dropdown">
  81. <a href="#" class="dropdown-toggle" data-toggle="dropdown">Storage <b class="caret"></b></a>
  82. <ul class="dropdown-menu">
  83. <li >
  84. <a href="storage/elephant/">Elephant</a>
  85. </li>
  86. <li >
  87. <a href="storage/bacon/">Bacon</a>
  88. </li>
  89. <li >
  90. <a href="storage/uncle-deadly/">Uncle Deadly</a>
  91. </li>
  92. </ul>
  93. </li>
  94. <li class="dropdown">
  95. <a href="#" class="dropdown-toggle" data-toggle="dropdown">Web <b class="caret"></b></a>
  96. <ul class="dropdown-menu">
  97. <li >
  98. <a href="web/dubsdot/">Dubsdot</a>
  99. </li>
  100. <li >
  101. <a href="web/info/">Info</a>
  102. </li>
  103. <li >
  104. <a href="web/library/">Library</a>
  105. </li>
  106. <li >
  107. <a href="web/docs/">Docs</a>
  108. </li>
  109. <li >
  110. <a href="web/gitea/">Gitea</a>
  111. </li>
  112. <li >
  113. <a href="web/eldoom/">Eldoom</a>
  114. </li>
  115. </ul>
  116. </li>
  117. </ul>
  118. <ul class="nav navbar-nav navbar-right">
  119. <li>
  120. <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
  121. <i class="fas fa-search"></i> Search
  122. </a>
  123. </li>
  124. </ul>
  125. </div>
  126. </div>
  127. </div>
  128. <div class="container">
  129. <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
  130. <ul class="nav bs-sidenav">
  131. <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>
  132. <li class="second-level"><a href="#contributing-to-info">Contributing to info/</a></li>
  133. <li class="third-level"><a href="#how-to-contribute">How to contribute:</a></li>
  134. </ul>
  135. </div></div>
  136. <div class="col-md-9" role="main">
  137. <h1 id="welcome-to-the-cosi-info-and-documentation-server">Welcome to the COSI Info and Documentation server!</h1>
  138. <p>Information about infrastructure, services and about the labs in general can be found throughout the site. </p>
  139. <div class="admonition warning">
  140. <p class="admonition-title">Warning</p>
  141. <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>
  142. </div>
  143. <h2 id="contributing-to-info">Contributing to info/</h2>
  144. <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>
  145. <h3 id="how-to-contribute">How to contribute:</h3>
  146. <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>
  147. <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>
  148. <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>
  149. </div>
  150. <footer class="col-md-12 text-center">
  151. <hr>
  152. <p>
  153. <small>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</small>
  154. </p>
  155. </footer>
  156. <script src="//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
  157. <script src="js/bootstrap-3.0.3.min.js"></script>
  158. <script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/highlight.min.js"></script>
  159. <script>hljs.initHighlightingOnLoad();</script>
  160. <script>var base_url = "."</script>
  161. <script src="js/base.js"></script>
  162. <script src="search/main.js"></script>
  163. <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
  164. <div class="modal-dialog modal-lg">
  165. <div class="modal-content">
  166. <div class="modal-header">
  167. <button type="button" class="close" data-dismiss="modal">
  168. <span aria-hidden="true">&times;</span>
  169. <span class="sr-only">Close</span>
  170. </button>
  171. <h4 class="modal-title" id="searchModalLabel">Search</h4>
  172. </div>
  173. <div class="modal-body">
  174. <p>
  175. From here you can search these documents. Enter
  176. your search terms below.
  177. </p>
  178. <form>
  179. <div class="form-group">
  180. <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
  181. </div>
  182. </form>
  183. <div id="mkdocs-search-results"></div>
  184. </div>
  185. <div class="modal-footer">
  186. </div>
  187. </div>
  188. </div>
  189. </div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
  190. <div class="modal-dialog">
  191. <div class="modal-content">
  192. <div class="modal-header">
  193. <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
  194. <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
  195. </div>
  196. <div class="modal-body">
  197. <table class="table">
  198. <thead>
  199. <tr>
  200. <th style="width: 20%;">Keys</th>
  201. <th>Action</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td class="help shortcut"><kbd>?</kbd></td>
  207. <td>Open this help</td>
  208. </tr>
  209. <tr>
  210. <td class="next shortcut"><kbd>n</kbd></td>
  211. <td>Next page</td>
  212. </tr>
  213. <tr>
  214. <td class="prev shortcut"><kbd>p</kbd></td>
  215. <td>Previous page</td>
  216. </tr>
  217. <tr>
  218. <td class="search shortcut"><kbd>s</kbd></td>
  219. <td>Search</td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. </div>
  224. <div class="modal-footer">
  225. </div>
  226. </div>
  227. </div>
  228. </div>
  229. </body>
  230. </html>
  231. <!--
  232. MkDocs version : 1.0.4
  233. Build Date UTC : 2020-07-08 21:42:30
  234. -->