Skip to content

Commit bef27db

Browse files
camillescottatworkcamillescottatwork
authored
Merge pull request #29 from ucdavis/camille/admin-header
Warn end-users about admin docs
2 parents 3216d07 + 9e2d797 commit bef27db

File tree

11 files changed

+108
-7
lines changed

11 files changed

+108
-7
lines changed

‎docs/admin/configuration.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
# Configuration Management
1+
---
2+
template: admin.html
3+
title: Configuration Management
4+
---
25

36
ie: puppet

‎docs/admin/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: About
3+
---
4+
5+
This section is for HPCCF admins to document our internal infrastructure, processes, and
6+
architectures.
7+
Although the information may be of _interest_ to end users, it is not designed or maintained for
8+
their consumption; nothing written here should be confused as an offering of service.
9+
For example, although we describe our [Virtual Machine](vms.md) infrastructure, which we used for
10+
hosting a variety of production-essential services for our clusters, we do **not** offer VM hosting
11+
for end users.
12+
13+

‎docs/admin/monitoring.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# Monitoring
1+
---
2+
template: admin.html
3+
title: Monitoring
4+
---

‎docs/admin/netbox.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Netbox
1+
---
2+
template: admin.html
3+
title: Netbox
4+
---
25

36
[HPCCF's Netbox Site](https://netbox.hpc.ucdavis.edu/dcim/sites/) is our source of truth for our
47
rack layouts, network addressing, and other infrastructure. NetBox is an infrastructure resource modeling (IRM) application designed to empower network automation. NetBox was developed specifically to address the needs of network and infrastructure engineers.
@@ -54,3 +57,4 @@ This section will give an overview of how HPCCF admins utilize and administer Ne
5457
3. Once selected you will come to a screen that looks like this: ![netbox22](../img/netbox22.jpeg)![netbox23](../img/netbox23.jpeg)![netbox24](../img/netbox24.jpeg)
5558

5659
4. Once all filled out with the required information to complete the connection (and any additional information that can be provided) at the bottom make sure to create the connection, your screen should look something like this: ![netbox25](../img/netbox25.jpeg)![netbox26](../img/netbox26.jpeg)![netbox27](../img/netbox27.jpeg)
60+

‎docs/admin/network.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# Network Architecture
1+
---
2+
template: admin.html
3+
title: Network
4+
---

‎docs/admin/provisioning.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
# Provisioning
1+
---
2+
template: admin.html
3+
title: Provisioning
4+
---
25

36
(cobbler, etc)

‎docs/admin/software.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Software
1+
---
2+
template: admin.html
3+
title: Software Deployment
4+
---
25

36
## Spack
47

‎docs/admin/vms.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# Virtual Machines
1+
---
2+
template: admin.html
3+
title: Virtual Machines
4+
---

‎mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ nav:
3737
- Resources: franklin/resources.md
3838
- Storage: franklin/storage.md
3939
- Admin:
40+
- admin/index.md
4041
- Network Architecture: admin/network.md
4142
- Virtual Machines: admin/vms.md
4243
- Provisioning: admin/provisioning.md
@@ -95,6 +96,7 @@ extra_javascript:
9596

9697
theme:
9798
name: material
99+
custom_dir: overrides
98100
features:
99101
- content.code.annotate
100102
#- navigation.tabs

‎overrides/admin.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{% extends "base.html" %}
2+
{% block content %}
3+
{% include "partials/admin-content.html" %}
4+
{% endblock %}

‎overrides/partials/admin-content.html

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<!--
2+
Copyright (c) 2016-2024 Martin Donath <martin.donath@squidfunk.com>
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to
6+
deal in the Software without restriction, including without limitation the
7+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8+
sell copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in
12+
all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20+
IN THE SOFTWARE.
21+
-->
22+
23+
<!-- Tags -->
24+
{% if "material/tags" in config.plugins and tags %}
25+
{% include "partials/tags.html" %}
26+
{% endif %}
27+
28+
<!-- Actions -->
29+
{% include "partials/actions.html" %}
30+
31+
<!--
32+
Hack: check whether the content contains a h1 headline. If it doesn't, the
33+
page title (or respectively site name) is used as the main headline.
34+
-->
35+
{% if "\x3ch1" not in page.content %}
36+
<h1>{{ page.title | d(config.site_name, true)}}</h1>
37+
{% endif %}
38+
39+
<div class="admonition warning">
40+
<p class="admonition-title">Warning</p>
41+
<p>
42+
This documentation is for internal use.
43+
It may be of interest to users who are curious about our internal processes and architecture, but should not be mistaken for describing services that we offer or stable infrastructure that end users should rely upon.
44+
<strong>
45+
If you find yourself submitting a ticket about something on this page, you are probably making a mistake.
46+
</strong>
47+
</p>
48+
</div>
49+
50+
<!-- Page content -->
51+
{{ page.content }}
52+
53+
<!-- Source file information -->
54+
{% include "partials/source-file.html" %}
55+
56+
<!-- Was this page helpful? -->
57+
{% include "partials/feedback.html" %}
58+
59+
<!-- Comment system -->
60+
{% include "partials/comments.html" %}

0 commit comments

Comments
 (0)