diff --git a/contributing/docs-and-notebooks.qmd b/contributing/docs-and-notebooks.qmd index 357c4da0..54eded14 100644 --- a/contributing/docs-and-notebooks.qmd +++ b/contributing/docs-and-notebooks.qmd @@ -5,6 +5,10 @@ subtitle: Conventions for Jupyter notebooks Contribution to VEDA's documentation is always welcome - just open a [Pull Request on the veda-docs repository](https://github.com/NASA-IMPACT/veda-docs). +You can submit a PR by forking the repository and submitting a PR with your fork. However, PR previews will not work for PRs from forks. You can push directly to this repository by becoming a collaborator. If you are not already a collaborator of the `veda-docs` repository, please email your github handle and veda@uah.edu along with a message like "please add me as a collaborator to the veda-docs repository so I can push a branch". If you are not someone already familiar with the VEDA team, please add some additional information about your interest in contributing to the documentation. + +Once you are a collaborator, you will be able to submit a PR from a branch of this repository (that is, not a branch from a fork) and PR previews will help in the review process. + Please note that this documentation site is rendered using [Quarto](https://quarto.org/), which adds a small set of configuration options on top of vanilla Markdown and Jupyter Notebooks. @@ -83,4 +87,4 @@ To present consistent best practices, we always access data via the STAC API. Of We use [`nbgitpuller`](https://hub.jupyter.org/nbgitpuller/) links to open the VEDA JupyterHub with a particular notebook pulled in. These links have the form: `https://nasa-veda.2i2c.cloud/hub/user-redirect/git-pull?repo=https://github.com/NASA-IMPACT/veda-docs&urlpath=lab/tree/veda-docs/notebooks/quickstarts/open-and-plot.ipynb&branch=main` If you are writing a notebook and want to share it with others you can generate your own `nbgitpuller` link using this -[link generator](https://hub.jupyter.org/nbgitpuller/link?hub=https://nasa-veda.2i2c.cloud&repo=https://github.com/NASA-impact/veda-docs&branch=main&app=jupyterlab). \ No newline at end of file +[link generator](https://hub.jupyter.org/nbgitpuller/link?hub=https://nasa-veda.2i2c.cloud&repo=https://github.com/NASA-impact/veda-docs&branch=main&app=jupyterlab).