Skip to content

Commit e56bf00

Browse files
committed
update CONTRIBUTING to include updating github pages doc site custom domain
1 parent 16b8eab commit e56bf00

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,10 @@ nbdev_export
6565
- In notebooks such as tutorial notebooks you may want to add a Google Colab link at the beginning of the notebook for easy accessibility.
6666
- There is no automatic way yet to update this so it's a manual update of a markdown cell. Since the link points to a notebook in master, testing the Colab button is done after merging. Follow the sample below and replace the notebook name with your contributed notebook name.
6767
- Sample for notebooks/14_datasets_nightlights.ipynb:
68-
[![](https://colab.research.google.com/assets/colab-badge.svg "Open in Colab button")](https://colab.research.google.com/github/thinkingmachines/geowrangler/blob/master/notebooks/14_datasets_nightlights.ipynb)
68+
[![](https://colab.research.google.com/assets/colab-badge.svg "Open in Colab button")](https://colab.research.google.com/github/thinkingmachines/geowrangler/blob/master/notebooks/14_datasets_nightlights.ipynb)
69+
70+
## Updating GitHub pages doc site domain after PR is merged
71+
- After your PR is merged, go the repo site on GitHub -> `Settings` -> `Pages`
72+
- Update the Custom Domain to be geowrangler.thinkingmachin.es
73+
- We need to update this after every PR merge because GitHub resets the custom domain to blank
74+
- If you don't have access to `Settings`, then feel free to reach out to the maintainers to update on your behalf.

0 commit comments

Comments
 (0)