Skip to content

Commit 426eb4a

Browse files
committed
remove winter break snowing layout
1 parent 398c960 commit 426eb4a

File tree

3 files changed

+133
-22
lines changed

3 files changed

+133
-22
lines changed

docs/get-started/index.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# NERC Getting Started Index
2+
3+
If you're just starting out, we recommend starting from [User Onboarding Process Overview](user-onboarding-on-NERC.md)
4+
and going through the tutorial in order.
5+
6+
If you just need to review a specific step, you can find the page you need in
7+
the list below.
8+
9+
## Cost & Billing
10+
11+
- [How does NERC pricing work?](cost-billing/how-pricing-works.md)
12+
**<<-- Start Here**
13+
14+
- [Pricing for Bare Metal Machines on NERC](cost-billing/pricing-for-bare-metal-machines.md)
15+
16+
- [NERC Pricing Calculator](cost-billing/nerc-pricing-calculator.md)
17+
18+
### Billing Process
19+
20+
- [Billing Process for My Institution](cost-billing/billing-process-for-my-institution.md)
21+
22+
- [Billing Process for Harvard University](cost-billing/billing-process-for-harvard.md)
23+
24+
- [Billing Process for Boston University](cost-billing/billing-process-for-bu.md)
25+
26+
- [Billing FAQs](cost-billing/billing-faqs.md)
27+
28+
## User Onboarding Steps
29+
30+
- [User Onboarding Process](user-onboarding-on-NERC.md)
31+
32+
## User Registration using MGHPCC Shared Services Account Portal a.k.a. RegApp
33+
34+
- [How to Create a User Account](create-a-user-portal-account.md)
35+
36+
## How to Get Resource Allocations using ColdFront?
37+
38+
- [What is NERC's ColdFront?](allocation/coldfront.md)
39+
40+
- [A New Project Creation Process](allocation/adding-a-project.md)
41+
42+
- [Managing Users in the Project](allocation/manage-users-to-a-project.md)
43+
44+
- [How to request a new Resource Allocation](allocation/requesting-an-allocation.md)
45+
46+
- [Request change to Resource Allocation to an existing project](allocation/allocation-change-request.md)
47+
48+
- [Adding a new Resource Allocation to the project](allocation/adding-a-new-allocation.md)
49+
50+
- [Managing Users in the Project Resource Allocation](allocation/managing-users-to-an-allocation.md)
51+
52+
- [Project and Individual Allocation Annual Review Process](allocation/project-and-allocation-review.md)
53+
54+
- [Archiving an Existing Project](allocation/archiving-a-project.md)
55+
56+
- [Allocation details](allocation/allocation-details.md)
57+
58+
## Security Best Practices for the NERC Users
59+
60+
- [Quick Guide and Best Practices](best-practices/best-practices.md)
61+
62+
- [Best Practices for My Institution](best-practices/best-practices-for-my-institution.md)
63+
64+
- [Best Practices for Harvard University](best-practices/best-practices-for-harvard.md)
65+
66+
- [Best Practices for Boston University](best-practices/best-practices-for-bu.md)
67+
68+
---

mkdocs.yaml

Lines changed: 50 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ site_author: NERC
66
site_url: https://nerc-project.github.io/nerc-docs/
77
repo_name: nerc-project/nerc-docs
88
repo_url: https://github.com/nerc-project/nerc-docs
9+
edit_uri: edit/main/docs/
910

1011
nav:
1112
- Home: index.md
1213
- About: about.md
1314
- Getting Started:
15+
- Getting Started: get-started/index.md
1416
- Cost & Billing:
1517
- How does NERC pricing work?: get-started/cost-billing/how-pricing-works.md
1618
- Pricing for Bare Metal Machines on NERC: get-started/cost-billing/pricing-for-bare-metal-machines.md
@@ -198,23 +200,31 @@ theme:
198200
icon: material/toggle-switch
199201
name: Switch to light mode
200202
features:
201-
- content.code.copy
202-
# - navigation.instant
203-
# - navigation.tracking
204-
# - navigation.sections
205-
# - navigation.indexes
206-
- navigation.top
207203
# - navigation.tabs
208204
# - navigation.tabs.sticky
209205
# - navigation.expand
206+
- content.action.edit
207+
- content.code.copy
208+
# - content.tabs.link
210209
- content.code.annotate
211-
- content.tabs.link
210+
- navigation.instant
211+
- navigation.instant.prefetch
212+
- navigation.instant.progress
213+
- navigation.tracking
214+
- navigation.sections
215+
- navigation.indexes
216+
- navigation.top
217+
- navigation.path
218+
- search.highlight
219+
- search.share
220+
# - toc.integrate
221+
- toc.follow
212222
extra_css:
213223
- stylesheets/extra.css
214-
- stylesheets/snow.css
224+
# - stylesheets/snow.css
215225
extra_javascript:
216226
- javascripts/extra.js
217-
- javascripts/snow.js
227+
# - javascripts/snow.js
218228
extra:
219229
font:
220230
text: Roboto
@@ -228,17 +238,41 @@ extra:
228238

229239
# Extensions
230240
markdown_extensions:
231-
- admonition
232-
- pymdownx.details
233-
- pymdownx.superfences
241+
# - pymdownx.tabbed:
242+
# alternate_style: true
234243
- tables
235244
- attr_list
236245
- md_in_html
237-
- pymdownx.blocks.caption
238-
- pymdownx.tabbed:
239-
alternate_style: true
246+
- admonition
247+
- pymdownx.details
248+
# For content tabs
240249
- pymdownx.superfences
250+
- pymdownx.blocks.caption
251+
# For code highlighting
252+
- pymdownx.highlight:
253+
anchor_linenums: true
254+
line_spans: __span
255+
pygments_lang_class: true
256+
- pymdownx.inlinehilite
257+
- pymdownx.snippets
258+
# For in page [TOC] (not sidebar)
259+
# - toc:
260+
# permalink: true
241261

242262
plugins:
243-
- material/search
263+
- search
264+
# - autorefs
265+
# - awesome-nav
244266
- glightbox
267+
- git-revision-date-localized:
268+
# exclude autogenerated files
269+
exclude:
270+
- argparse/*
271+
- examples/*
272+
- minify:
273+
minify_html: true
274+
minify_js: true
275+
minify_css: true
276+
cache_safe: true
277+
js_files: [docs/javascripts/*.js]
278+
css_files: [docs/stylesheets/*.css]

requirements.txt

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
1-
mkdocs==1.6.0
2-
mkdocs-material==9.5.30
3-
mkdocs-material-extensions==1.3.1
4-
mkdocs-glightbox==0.4.0
5-
pre-commit==3.8.0
6-
Jinja2>=3.1,<3.2
1+
mkdocs
2+
# mkdocs-api-autonav
3+
mkdocs-material
4+
mkdocs-material-extensions
5+
mkdocstrings-python
6+
# mkdocs-gen-files
7+
# mkdocs-awesome-nav
8+
mkdocs-glightbox
9+
mkdocs-git-revision-date-localized-plugin
10+
mkdocs-minify-plugin
11+
regex
12+
ruff
13+
pydantic
14+
pre-commit
15+
Jinja2
716
git+https://github.com/CCI-MOC/nerc-rates@main#egg=nerc_rates

0 commit comments

Comments
 (0)