Merge pull request #246 from argonne-lcf/hotfix/not_in_nav

Add new mkdocs feature to suppress INFO output from nav; cleanup ai-testbed docs

.github/workflows/test-mkdocs-build.yml

@@ -0,0 +1,20 @@
+name: update-livesite
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ branches: [ master ]
+
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ submodules: recursive
+ - uses: actions/setup-python@v4
+ with:
+ python-version: 3.x
+ - run: pip install -r requirements.txt
+ - run: mkdocs build --strict

.github/workflows/update-livesite.yml

@@ -8,11 +8,11 @@ jobs:
  deploy:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
  with:
  submodules: recursive
- - uses: actions/setup-python@v2
+ - uses: actions/setup-python@v4
  with:
  python-version: 3.x
  - run: pip install -r requirements.txt
- - run: mkdocs gh-deploy --force
+ - run: mkdocs gh-deploy --force --strict

Makefile

@@ -8,7 +8,7 @@ install-dev:
 
 .PHONY: build-docs
 build-docs:
- mkdocs build
+ mkdocs build --strict
 
 
 .PHONY: all

docs/account-project-management/allocation-management/allocation-management.md

@@ -2,14 +2,14 @@
 Allocations require management – balance checks, resource allocation, requesting more time, etc.
 
 ## Checking for an Active Allocation
-To determine if there is an active allocation, check [Job Submision](../../../theta/queueing-and-running-jobs/job-and-queue-scheduling/#submit-a-job).
+To determine if there is an active allocation, check [Job Submission](../../theta/queueing-and-running-jobs/job-and-queue-scheduling.md#submit-a-job).
 
 For information on how to run the query, look at our documentation on our [sbank Allocations Accounting System](sbank-allocation-accounting-system.md) or email [[email protected]](mailto:[email protected]) and ask for all active allocations.
 
 ## Using sbank to Determine the Balance of an Allocation
 To determine which platforms have an active balance, check our allocation accounting system [sbank](sbank-allocation-accounting-system.md).
 
-- To obtain the allocation balance, check the sbank command [sbank-list-allocations](sbank-list-allocations.md).
+- To obtain the allocation balance, check the sbank command [sbank-list-allocations](not_in_nav/sbank-list-allocations.md).
 - DD projects with a negative balance will not be able to run jobs until they have requested additional time, see Getting more time below.
 - INCITE and ALCC PIs automatically email a summary of project usage. If this is a DD project, please email [[email protected]](mailto:[email protected]).
 

docs/account-project-management/allocation-management/sbank-allocation-accounting-system.md

@@ -5,22 +5,22 @@ The sbank accounting system helps users manage their allocations and usage per j
 
 ## Getting Started with sbank
 
-[sbank Example Commands](sbank-examples.md) provides a set of example commands on how to use the most common commands. 
+[sbank Example Commands](not_in_nav/sbank-examples.md) provides a set of example commands on how to use the most common commands. 
 
 ## sbank Man Pages
 
 Use these sbank man pages to get information on how to use the commands.
 
-- [sbank](sbank-manpage.md)
-- [sbank-detail](sbank-detail.md)
-- [sbank-detail-allocations](sbank-detail-allocations.md)
-- [sbank-detail-jobs](sbank-detail-jobs.md)
-- [sbank-detail-projects](sbank-detail-projects.md)
-- [sbank-detail-transactions](sbank-detail-transactions.md)
-- [sbank-detail-users](sbank-detail-users.md)
-- [sbank-list](sbank-list.md)
-- [sbank-list-allocations](sbank-list-allocations.md)
-- [sbank-list-jobs](sbank-list-jobs.md)
-- [sbank-list-projects](sbank-list-projects.md)
-- [sbank-list-transactions](sbank-list-transactions.md)
-- [sbank-list-users](sbank-list-users.md)
+- [sbank](not_in_nav/sbank-manpage.md)
+- [sbank-detail](not_in_nav/sbank-detail.md)
+- [sbank-detail-allocations](not_in_nav/sbank-detail-allocations.md)
+- [sbank-detail-jobs](not_in_nav/sbank-detail-jobs.md)
+- [sbank-detail-projects](not_in_nav/sbank-detail-projects.md)
+- [sbank-detail-transactions](not_in_nav/sbank-detail-transactions.md)
+- [sbank-detail-users](not_in_nav/sbank-detail-users.md)
+- [sbank-list](not_in_nav/sbank-list.md)
+- [sbank-list-allocations](not_in_nav/sbank-list-allocations.md)
+- [sbank-list-jobs](not_in_nav/sbank-list-jobs.md)
+- [sbank-list-projects](not_in_nav/sbank-list-projects.md)
+- [sbank-list-transactions](not_in_nav/sbank-list-transactions.md)
+- [sbank-list-users](not_in_nav/sbank-list-users.md)

docs/account-project-management/project-management/starting-alcf-award.md

@@ -106,7 +106,7 @@ The ALCF will send you a report template at the end of each quarter. Please comp
 Please be aware that we will periodically monitor, and could potentially adjust, your project allocation if a large portion of it goes unused. You may view: [Pullback Policy](../../policies/queue-scheduling/pullback-policy.md)
 
 ### Allocation Overburn Policy
-Please see this page for overburn/overuse eligibility for INCITE projects that have exhausted their allocation in the first 11 months of its allocation year: [Allocation Overburn](../../../policies/queue-scheduling/queue-and-scheduling-policy/#incitealcc-overburn-policy)
+Please see this page for overburn/overuse eligibility for INCITE projects that have exhausted their allocation in the first 11 months of its allocation year: [Allocation Overburn](../../policies/queue-scheduling/queue-and-scheduling-policy.md#incitealcc-overburn-policy)
 
 ### Acknowledgment In Publications
 Please follow the guidelines provided on the [ALCF Acknowledgement Policy page](../../policies/alcf-acknowledgement-policy.md) to properly acknowledge the use of ALCF resources in all of your publications, both online and print.

docs/ai-testbed/index.md → docs/ai-testbed/getting-started.md

@@ -34,4 +34,4 @@ Submit your proposal requests at: [Allocation Request Page](https://accounts.alc
 The documentation is based on [MkDocs](https://www.mkdocs.org/){:target="_blank"} and source files are
 on [GitHub](https://github.com/argonne-lcf/ai-testbed-userdocs). You can contribute to the documentation by creating a pull request. 
 
- [Learn more on how to contribute to documentation.](howto-contribute.md)
+ [Learn more on how to contribute to documentation.](https://github.com/argonne-lcf/user-guides/blob/main/README.md)

docs/ai-testbed/graphcore/Scaling-ResNet50.md → docs/ai-testbed/graphcore/unused/Scaling-ResNet50.md

@@ -1,6 +1,6 @@
 # Scaling ResNet50
 
-Follow all the instructions in [Getting Started](/docs/graphcore/Getting-Started) to log into a Graphcore node.
+Follow all the instructions in [Getting Started](../getting-started.md) to log into a Graphcore node.
 
 ## Examples Repo
 
@@ -131,12 +131,12 @@ You should see:
 # gc-poplar-04:22 SSH-2.0-OpenSSH_8.2p1 Ubuntu-4ubuntu0.5
 ```
 
-## Benchmarks.yml
+## `benchmarks.yml`
 
 Update **${HOME}/graphcore/examples/vision/cnns/pytorch/train/benchmarks.yml**
-with your favorite editor to match [benchmarks.yml](/docs/graphcore/benchmarks.yml).
+with your favorite editor to match [benchmarks.yml](./files/benchmarks.yml).
 
-## Configs.yml
+## `configs.yml`
 
 Update **${HOME}/graphcore/examples/vision/cnns/pytorch/train/configs.yml**
 with your favorite editor. At about line 30, change **use_bbox_info: true** to

docs/ai-testbed/graphcore/profiling-mnist.md → docs/ai-testbed/graphcore/unused/profiling-mnist.md

@@ -1,10 +1,10 @@
 # Profiling MNIST
 
-Follow all the instructions in [Getting Started](/docs/graphcore/Getting-Started) to log into a Graphcore node.
+Follow all the instructions in [Getting Started](../getting-started.md) to log into a Graphcore node.
 
-Follow the instructions in [Virtual Environments](/docs/graphcore/Virtual-Environments) up to and including **PopART Environment Setup**.
+Follow the instructions in [Virtual Environments](../virtual-environments.md) up to and including **PopART Environment Setup**.
 
-Following the instructions in [Example Programs](/docs/graphcore/Example-Programs) up to and including
+Following the instructions in [Example Programs](../example-programs.md) up to and including
 **MNIST, Install Requirements**.
 
 ## Change Directory
@@ -33,4 +33,4 @@ Do so by running the following command:
 python mnist_poptorch.py
 ```
 
-When MNIST has finished running, see [Profiling](/docs/graphcore/Profiling) to use **Graph Analyser**.
+When MNIST has finished running, see [Profiling](./profiling.md) to use **Graph Analyser**.

docs/ai-testbed/graphcore/profiling-resnet50.md → docs/ai-testbed/graphcore/unused/profiling-resnet50.md

@@ -1,8 +1,8 @@
 # Profiling ResNet50
 
-Follow all the instructions in [Getting Started](/docs/graphcore/Getting-Started) to log into a Graphcore node.
+Follow all the instructions in [Getting Started](../getting-started.md) to log into a Graphcore node.
 
-Follow the instructions in [Virtual Environments](/docs/graphcore/Virtual-Environments) up to and including **PopART Environment Setup**.
+Follow the instructions in [Virtual Environments](../virtual-environments.md) up to and including **PopART Environment Setup**.
 
 ## Examples Repo
 
@@ -58,4 +58,4 @@ python3 -m examples_utils benchmark --spec benchmarks.yml --benchmark pytorch_re
 
 ## Profile Results
 
-When ResNet50 has finished running, see [Profiling](/docs/graphcore/Profiling) to use **Graph Analyser**.
+When ResNet50 has finished running, see [Profiling](./profiling.md) to use **Graph Analyser**.

docs/ai-testbed/graphcore/profiling.md → docs/ai-testbed/graphcore/unused/profiling.md

@@ -69,7 +69,7 @@ cd /path/to/graph/analyser/directory
 
 ![Graph Analyser](files/Graph_Ananlyser_main.jpg "Graph Analyser")
 
-![Graphcore System View](files/image.png "Graphcore System View")
+![Graphcore System View](files/graphcore-sys-view.png "Graphcore System View")
 
 1. Click **Open a report...**;
 2. Click the **remote** tab;

docs/ai-testbed/sambanova_gen1/example-programs.md

@@ -273,7 +273,7 @@ cp -r /opt/sambaflow/apps/image ~/apps/image
 cd ~/apps/image/unet
 ```
 
-Using the contents of [unet_compile_run_inf_rl.sh](unet_compile_run_inf_rl.sh), create a file in the current directory with the same name.
+Using the contents of [unet_compile_run_inf_rl.sh](files/unet_compile_run_inf_rl.sh), create a file in the current directory with the same name.
 
 Export the path to the dataset which is required for the training.