Workflow

In general the workflow for the app can be called github based. The app relies on data which is pushed from github and is validated.

It can happen that a file goes out of sync, but the data is kept in the github repository separated from the code to be available for other implementations and applications.

That is to say, if you do not see your data updated in few seconds, then please see the validation page and if this does not help, open an issue.

Once you have Github installed and the repositories are all up to date you are ready to start.

Open on your computer the folder where you have cloned the github repository, for example a BetMas folder on your desktop where you have the Manuscripts folder, which is actually the cloned repository.

Select the file you want to edit, e.g. EMIP00001.xml. Open the file with Atom or Oxygen or any other XML editing software you like. You find more advice in the setup page for example to create a project, which will allow you to avoid having always to go back and between from your system and the software.

Following these guidelines, you can edit the file and save it.

Github will see the change and if you open it, you will see that it has recorded the changes you made (under the changes tab). When you are ready, you can make sure you have recorded your changes, that your files are valid and then you can commit them, leaving a commit message which explains nicely and clearly what you have done (i.e. avoid commit messages like 'upd' or 'changes'...). After few seconds, you can eventually check your file in the web application.

Some tasks, like finding the correct id for a reference or named entitiy, will need anyway to use the application, unless you prefer to search through the files directly in your editing software.

In very limited and checked cases you might need to create new entries. You need permission to do so via the application. then you can follow the guidance in the new record creation page.

Batch editing files

You can find and replace strings or regex patterns throughout the data in Oxygen for example. Before replacing all, you will be asked if you want to preview. This is always wise and gives you one more occasion to spot check your changes before performing the action. Please, make sure you untick the option to create .bak files - in case you forget, and such files are created, please DO NOT commit them.

In case you have anyway made a mistake, remember that before committing data you can review in Git desktop the changes and discard them if they are wrong. If you have committed, pushed and you realize it was a big mistake, you can still revert your own commit

Keeping track

To keep track of the workflow we used to refer to a google drive spreadsheet. This workflow is deprecated and discouraged in any way, as the spreadsheet is outdated by two years and should not be used to support any statement about entities in the website. Its historical purpose, and usage to originate the initial batch of data does not justify the redundancy of going back to look into that.

You can use your user page to see what you have done recently or use the latest function to see what is new in the data.

This page is referred to in the following pages

Revisions of this page

  • Pietro Maria Liuzzo on 2018-04-30: first version of guidelines from Wiki