diff --git a/docs/dev/development.md b/docs/dev/development.md index e11557b47d..d4429dd12e 100644 --- a/docs/dev/development.md +++ b/docs/dev/development.md @@ -20,4 +20,9 @@ A recent Linux distribution is recommended, although it should be possible to bu ## Contributing -We welcome contributions to the project. See our [ways of working for more detail](ways-of-working.md). All contributors must sign the [GCHQ Contributor Licence Agreement](https://cla-assistant.io/gchq/Gaffer). \ No newline at end of file +We welcome contributions to the project. See our [ways of working for more +detail](ways-of-working.md). All contributors must sign the [GCHQ Contributor +Licence Agreement](https://cla-assistant.io/gchq/Gaffer). + +You can quickly and easily contribute towards Gaffer using a [remote coding +environment](remote-coding-environments.md) such as GitHub Codespaces or Gitpod. \ No newline at end of file diff --git a/docs/dev/remote-coding-environments.md b/docs/dev/remote-coding-environments.md new file mode 100644 index 0000000000..c1786964e2 --- /dev/null +++ b/docs/dev/remote-coding-environments.md @@ -0,0 +1,32 @@ +# Remote Coding Environments For Gaffer + +Gaffer is now configured for remote coding environemnts such as GitHub +Codespaces and Gitpod. This addition allows for an easier and faster way to +contribute to Gaffer with no manual setup or need to download dependencies to a +local machine. + +## GitHub Codespaces +To use GitHub Codespaces simply open the Gaffer repository, click the "Code" +button drop down, and then the option labeled "Create codespace on develop". + +This will launch a Codespaces environment with all the configuration needed to +contribute to Gaffer. See the [GitHub documentation for more information on +Codespaces] (https://github.com/features/codespaces). + +## Gitpod +To use Gitpod you can simply prefix any GitHub URL with **`gitpod.io/#`** and +follow the steps from there. You can also install the +[extension](https://www.gitpod.io/docs/configure/user-settings/browser-extension) +on your web browser. This adds a button to GitHub that does the prefixing for +you. + +Our custom GitPod configuration removes your Git commit email so you +will need to [re-configure your Git commit +email](https://www.gitpod.io/docs/configure/authentication/github). You can also +[configure your Git commit email to be a private GitHub email or a custom email +too.](https://www.gitpod.io/docs/configure/authentication#how-to-use-a-private-github-email-or-custom-email-for-git-commits). +Once done your environment will be all set to contribute to the Gaffer +repository. + +See the [Gitpod documentation for more +information.](https://www.gitpod.io/docs/introduction). \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index fb4d2e70e1..9f56483b75 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,6 +68,7 @@ nav: - 'Log4j in Gaffer': 'gaffer2.0/log4j.md' - 'Developer Docs': - 'Development': 'dev/development.md' + - 'Remote Coding Environments': 'dev/remote-coding-environments.md' - 'Managing Dependencies': 'dev/managing-dependencies/managing-dependencies.md' - 'Ways of Working': 'dev/ways-of-working.md' - 'Sketches custom deserialisation': 'dev/rest-api-sketches.md'