Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions docs/get-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# NERC Getting Started Index

If you're just starting out, we recommend starting from
[User Onboarding Process Overview](user-onboarding-on-NERC.md) and going through
the tutorial in order.

If you just need to review a specific step, you can find the page you need in
the list below.

## Cost & Billing

- [How does NERC pricing work?](cost-billing/how-pricing-works.md)
**<<-- Start Here**

- [Pricing for Bare Metal Machines on NERC](cost-billing/pricing-for-bare-metal-machines.md)

- [NERC Pricing Calculator](cost-billing/nerc-pricing-calculator.md)

### Billing Process

- [Billing Process for My Institution](cost-billing/billing-process-for-my-institution.md)

- [Billing Process for Harvard University](cost-billing/billing-process-for-harvard.md)

- [Billing Process for Boston University](cost-billing/billing-process-for-bu.md)

- [Billing FAQs](cost-billing/billing-faqs.md)

## User Onboarding Steps

- [User Onboarding Process](user-onboarding-on-NERC.md)

## User Registration using MGHPCC Shared Services Account Portal a.k.a. RegApp

- [How to Create a User Account](create-a-user-portal-account.md)

## How to Get Resource Allocations using ColdFront?

- [What is NERC's ColdFront?](allocation/coldfront.md)

- [A New Project Creation Process](allocation/adding-a-project.md)

- [Managing Users in the Project](allocation/manage-users-to-a-project.md)

- [How to request a new Resource Allocation](allocation/requesting-an-allocation.md)

- [Request change to Resource Allocation to an existing project](allocation/allocation-change-request.md)

- [Adding a new Resource Allocation to the project](allocation/adding-a-new-allocation.md)

- [Managing Users in the Project Resource Allocation](allocation/managing-users-to-an-allocation.md)

- [Project and Individual Allocation Annual Review Process](allocation/project-and-allocation-review.md)

- [Archiving an Existing Project](allocation/archiving-a-project.md)

- [Allocation details](allocation/allocation-details.md)

## Security Best Practices for the NERC Users

- [Quick Guide and Best Practices](best-practices/best-practices.md)

- [Best Practices for My Institution](best-practices/best-practices-for-my-institution.md)

- [Best Practices for Harvard University](best-practices/best-practices-for-harvard.md)

- [Best Practices for Boston University](best-practices/best-practices-for-bu.md)

---
16 changes: 16 additions & 0 deletions docs/openshift/decommission/decommission-openshift-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,22 @@ Please check all the resources currently being used by your project by running
the `oc get all` command, is a **REQUIRED** resource, and so you don't need
to clean it up.

## Optional: Remove User(s) from your ColdFront Project

Removing users from your ColdFront project via the [NERC's ColdFront interface](https://coldfront.mss.mghpcc.org/)
is straightforward. Simply click the "Remove Users" button for the corresponding
project. This will display the following interface:

![Remove User(s) From A Project](images/coldfront-remove-users-from-a-project.png)

PI or project managers can select the user(s) and then click on the "Remove Selected
Users From Project" button.

!!! note "Very Important"

If you remove a user (or users) from a project, they will automatically be
removed from all allocations they were previously assigned to within that project.

## Use ColdFront to reduce the Storage Quota to Zero

Each allocation, whether requested or approved, will be billed based on the
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/openstack/decommission/decommission-openstack-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,22 @@ Navigate to _Project -> Object Store -> Containers_.
So, you don't need to manually delete all objects inside a container prior
deleting the container. This will save a lot of your time and effort.

## Optional: Remove User(s) from your ColdFront Project

Removing users from your ColdFront project via the [NERC's ColdFront interface](https://coldfront.mss.mghpcc.org/)
is straightforward. Simply click the "Remove Users" button for the corresponding
project. This will display the following interface:

![Remove User(s) From A Project](images/coldfront-remove-users-from-a-project.png)

PI or project managers can select the user(s) and then click on the "Remove Selected
Users From Project" button.

!!! note "Very Important"

If you remove a user (or users) from a project, they will automatically be
removed from all allocations they were previously assigned to within that project.

## Use ColdFront to reduce the Storage Quota to Zero

Each allocation, whether requested or approved, will be billed based on the
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 50 additions & 16 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ site_author: NERC
site_url: https://nerc-project.github.io/nerc-docs/
repo_name: nerc-project/nerc-docs
repo_url: https://github.com/nerc-project/nerc-docs
edit_uri: edit/main/docs/

nav:
- Home: index.md
- About: about.md
- Getting Started:
- Getting Started: get-started/index.md
- Cost & Billing:
- How does NERC pricing work?: get-started/cost-billing/how-pricing-works.md
- Pricing for Bare Metal Machines on NERC: get-started/cost-billing/pricing-for-bare-metal-machines.md
Expand Down Expand Up @@ -198,23 +200,31 @@ theme:
icon: material/toggle-switch
name: Switch to light mode
features:
- content.code.copy
# - navigation.instant
# - navigation.tracking
# - navigation.sections
# - navigation.indexes
- navigation.top
# - navigation.tabs
# - navigation.tabs.sticky
# - navigation.expand
- content.action.edit
- content.code.copy
# - content.tabs.link
- content.code.annotate
- content.tabs.link
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.tracking
- navigation.sections
- navigation.indexes
- navigation.top
- navigation.path
- search.highlight
- search.share
# - toc.integrate
- toc.follow
extra_css:
- stylesheets/extra.css
- stylesheets/snow.css
# - stylesheets/snow.css
extra_javascript:
- javascripts/extra.js
- javascripts/snow.js
# - javascripts/snow.js
extra:
font:
text: Roboto
Expand All @@ -228,17 +238,41 @@ extra:

# Extensions
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
# - pymdownx.tabbed:
# alternate_style: true
- tables
- attr_list
- md_in_html
- pymdownx.blocks.caption
- pymdownx.tabbed:
alternate_style: true
- admonition
- pymdownx.details
# For content tabs
- pymdownx.superfences
- pymdownx.blocks.caption
# For code highlighting
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
# For in page [TOC] (not sidebar)
# - toc:
# permalink: true

plugins:
- material/search
- search
# - autorefs
# - awesome-nav
- glightbox
- git-revision-date-localized:
# exclude autogenerated files
exclude:
- argparse/*
- examples/*
- minify:
minify_html: true
minify_js: true
minify_css: true
cache_safe: true
js_files: [docs/javascripts/*.js]
css_files: [docs/stylesheets/*.css]
21 changes: 15 additions & 6 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
mkdocs==1.6.0
mkdocs-material==9.5.30
mkdocs-material-extensions==1.3.1
mkdocs-glightbox==0.4.0
pre-commit==3.8.0
Jinja2>=3.1,<3.2
mkdocs
# mkdocs-api-autonav
mkdocs-material
mkdocs-material-extensions
mkdocstrings-python
# mkdocs-gen-files
# mkdocs-awesome-nav
mkdocs-glightbox
mkdocs-git-revision-date-localized-plugin
mkdocs-minify-plugin
regex
ruff
pydantic
pre-commit
Jinja2
git+https://github.com/CCI-MOC/nerc-rates@main#egg=nerc_rates