Skip to content

Commit

Permalink
add private section
Browse files Browse the repository at this point in the history
  • Loading branch information
rdnajac committed Sep 25, 2024
1 parent 4395600 commit 3708de8
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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

Expand Down
9 changes: 9 additions & 0 deletions docs/private/index.md
Original file line number Diff line number Diff line change
@@ -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)
12 changes: 12 additions & 0 deletions docs/private/lab-website.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ site_description: A collection of how-to guides for the Palomero Lab
site_author: Ryan D. Najac
copyright: <a href="https://www.cuimc.columbia.edu/"><img src="https://github.com/PalomeroLab/how-to/blob/main/assets/CUIMC_Horizontal_Blue.png?raw=true" alt = "CUIMC Logo"></a><br>Copyright &copy; 2024 <a href="https://www.columbia.edu/">Columbia University</a>

# Put internal documenets here
not_in_nav: /private

theme:
name: readthedocs
Expand Down
2 changes: 2 additions & 0 deletions scripts/install-requirements
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/bin/bash
(cd $(git rev-parse --show-toplevel) && pip install -r requirements.txt)

0 comments on commit 3708de8

Please sign in to comment.