Skip to content
Snippets Groups Projects
Commit 0019b6be authored by Anne Lyle's avatar Anne Lyle :palm_tree:
Browse files

Added preliminary page about GitHub

parent ac9ef785
No related branches found
No related tags found
No related merge requests found
Pipeline #187590 passed with stages
in 2 minutes and 46 seconds
# Using GitHub and previewing your pages
At the moment we have no way to preview pages - everything pushed to master will go live. We are in the process of setting up a system to allow previews, but in the meantime here is an overview of how our continuous integration service works.
## GitHub and GitLab
While the repository is hosted on the public GitHub website, there is also a git-based site internal to the EBI, at https://gitlab.ebi.ac.uk. If you are an EBI employee, you can log into this site using your usual credentials.
We leverage the power of GitLab as follows (this is highly simplified!):
1. GitLab constantly monitors `github.com/Ensembl/ensembl-website-help-and-docs` for commits to master. When one is detected, it is copied from GitHub to GitLab.
1. Once the commit is downloaded, it triggers the build process, compiling the pages into HTML and adding navigation
- If the build fails, the new build is thrown away and GitLab waits for the next update
- If it succeeds, the new build is made available to the web frontend
To do - GitLab can inform GitHub of the status of the latest build, so that GitHub displays either a red cross or a green tick, as per the image below (from the ensembl-client repo). Clicking on the link will take you to GitLab, where you can find out more about the latest run.
## Creating branches
At the moment, we encourage content providers to use a feature branch to commit their changes, so that they can be reviewed by a web team member before merging into master.
## Staging site
Our plan is to set up a separate VM where content editors can preview changes before they are merged to master. This will reduce the need for manual reviewing of content and allow you to develop new content more easily!
......@@ -10,7 +10,7 @@ To make this documentation easier to use, it has been divided into several pages
- [How to add navigation](toc.md) with toc.yml files
- [How to work with GitHub](github.md) and the Ensembl continuous integration system
- [How to work with GitHub and preview your pages](github.md)
## An overview of the Help and About apps
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment