From 3708de8c0b60033d69718e4398bf6f4b0fa1750d Mon Sep 17 00:00:00 2001 From: "Ryan D. Najac" Date: Wed, 25 Sep 2024 16:57:13 -0400 Subject: [PATCH] add private section --- docs/index.md | 11 +++++++---- docs/private/index.md | 9 +++++++++ docs/private/lab-website.md | 12 ++++++++++++ mkdocs.yml | 2 ++ scripts/install-requirements | 2 ++ 5 files changed, 32 insertions(+), 4 deletions(-) create mode 100644 docs/private/index.md create mode 100644 docs/private/lab-website.md create mode 100755 scripts/install-requirements diff --git a/docs/index.md b/docs/index.md index 75a12e8..d25837b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,6 +12,10 @@ This guide covers a range of topics including: Read more about [this guide](about.md) or visit the project's original [GitHub repository](https://github.com/rdnajac/cbmf). +> [!IMPORTANT] +> Lab members [click here](private/index.md) to access the private section of +> the guide. + ## How to use this guide Browse the navigation bar, use the search function, @@ -24,10 +28,9 @@ or in a code block like the one this: echo "Hello, world!" ``` -> [!TIP] -> If you get `zsh: command not found: #` when you try to run a copied command, -> run `setopt interactivecomments` first. Read about why this happens -> [here](https://stackoverflow.com/a/11873793/26469286). +If you get a warning `$ zsh: command not found: #`, you may need to +run `setopt interactivecomments` first. Read about why this happens +[here](https://stackoverflow.com/a/11873793/26469286). ## Contributing diff --git a/docs/private/index.md b/docs/private/index.md new file mode 100644 index 0000000..b5d44c4 --- /dev/null +++ b/docs/private/index.md @@ -0,0 +1,9 @@ +# Private + +> [!CAUTION] +> Thise section is intended for Palomero Lab members +> and the content may not be useful to the general public. + +## Contents + +- [How to edit the lab website](lab-website.md) diff --git a/docs/private/lab-website.md b/docs/private/lab-website.md new file mode 100644 index 0000000..5804faf --- /dev/null +++ b/docs/private/lab-website.md @@ -0,0 +1,12 @@ +# [palomerolab.org](https://www.palomerolab.org/) + +1. Edit the description [here](https://github.com/PalomeroLab/palomerolab.github.io/blob/main/people.json) + +2. Once you commit your changes, you can check the status + [here](https://github.com/PalomeroLab/palomerolab.github.io/actions) + +3. Your changes should show up in the website if the build/deployment is successful + +> [!TIP] +> If you are not seeing your changes, try refreshing the page, +> clearing your cache, or opening the website in a private window. diff --git a/mkdocs.yml b/mkdocs.yml index a09ce0f..3a5621d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,6 +6,8 @@ site_description: A collection of how-to guides for the Palomero Lab site_author: Ryan D. Najac copyright: CUIMC Logo
Copyright © 2024 Columbia University +# Put internal documenets here +not_in_nav: /private theme: name: readthedocs diff --git a/scripts/install-requirements b/scripts/install-requirements new file mode 100755 index 0000000..1dfd0c7 --- /dev/null +++ b/scripts/install-requirements @@ -0,0 +1,2 @@ +#!/bin/bash +(cd $(git rev-parse --show-toplevel) && pip install -r requirements.txt)