Opening the CMS
The content management system (CMS) can be accessed with this link: www.blastodb.com/admin
You will need a GitHub Account, access rights to the Resository and a Personal Access Tocen (PAT) to log in. Go to GitHub Setup if you need help with that.
Logging in
- Click Sing In Using Access Token (-> You need to generate a PAT if you don't already have one)
- Paste the PAT you generated during setup from your favorite password manager into the text field.
- You are now in the CMS dashboard!
First Task: Add Yourself to the Acknowledgements
To get a feeling for how editing works, your first task will be to add yourself to the people that contribute to BlastoDB. You can do that by adding your information by clicking (on the left sidebar) Community -> People. Then, if you want, you can add your information by scrolling down and clicking Add Person (this is easyer if you click collapse all first). The information you add will be publically available, consider this before adding a picture or an email. Cou can find more information on the editors guide for people.
If you have more questions about the editorial workflow, continue reading the following section. It is a good idea to look at the description of each collection so you know which data to add, and where to be careful when editing.
The editorial workflow
The left sidebar in the dashboard lists all the content you can edit. This includes the content of the database, and the webpage itself.
The content of the database includes:
- Datasets — individual sequencing datasets
- Publications — the publication library
- Research Labs — lab profiles
- Lab Protocols — laboratory protocols
- Subtypes — Blastocystis subtype pages
- Vocabularies — controlled lists (datatypes, countries, sources, etc.)
The webpage can be edited here:
- Pages — the web-pages of BlastoDB
- Navigation — header and footer of BlastoDB
Your changes will not go live immediately. BlastoDB is build once a day at 5:30 UTC. You can also manually start the bild process as described below.
In case you accidentaly break something, you can always roll back a change. (It is a hassle though, try to avoid it.)
Manually Publishing BlastoDB
BlastoDB is build using GitHub Actions. The build is triggered automatically once per day at 5:30 UTC. If you want to manually override that:
- Open the GitHub Actions Page of BlastoDB (https://github.com/Tsaousis-Lab/blastodb/actions)
- Click Publish on the menu on the right side.
- You will see a new workflow start, which might take one to three minutes.
- If the circle is yellow, the workflow is running, wait till it finishes
- If the circle is green, the workflow run was successfull. You can now check your changes on the life website.
- If the circle is red, the workflow has failed. Check for any errors in the code. If you made a mistake, you need to roll back the change.