Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write help documentation for the new fields. #1442

Closed
Captainkirkdawson opened this issue Apr 29, 2018 · 62 comments
Closed

Write help documentation for the new fields. #1442

Captainkirkdawson opened this issue Apr 29, 2018 · 62 comments

Comments

@Captainkirkdawson
Copy link
Member

Captainkirkdawson commented Apr 29, 2018

Priority (2 3 6 3) 14

We need to document the new fields for the transcriber.

Needs #1371

@Captainkirkdawson
Copy link
Member Author

@AlOneill seems like I am running into a problem with the page being too long to store in the mysql database. May have to split the page into sub pages.

@AlOneill
Copy link
Contributor

No worries — separate sub-pages are fine — at least to start with.

I am thinking that there will be some sense in treating fields that are essentially the same, like all the _surname fields, in one entry. But let me think about that some more. When I suggested something similar (aggregating field descriptions) a couple of years ago, no-one seemed too keen, but given the sheer number of fields now available, and the increased duplication of information, a more elegant solution seems sensible.

@Sherlock21
Copy link

I am inclined to agree with Kirk. If the fields behave the same way as each other, then no point in yards of text being repeated. The user has to be credited with some mental dexterity after all.

@Captainkirkdawson
Copy link
Member Author

@Sherlock21 it was a suggestion from @AlOneill not me.

I had definitely been inclined to follow that suggestion for the common fields.

However I seem to have run into a size limitation that may force a different solution.

@Captainkirkdawson
Copy link
Member Author

@AlOneill
Copy link
Contributor

AlOneill commented Jul 1, 2018

@Captainkirkdawson Thanks.

To make for more pleasant reading, the markup needs a bit of an overhaul — I will need to do this offline, in a proper editor. When I take a copy of the page, probably in the next few days, I will leave a note at the top warning that any edits made in Refinery will be overwritten when I paste in the offline edits. If there is no such warning present, then you may edit freely. (Please let me know if that strategy looks ill-thought-out in any way.)

@Captainkirkdawson
Copy link
Member Author

@AlOneill have added your styling to the pages

@AlOneill
Copy link
Contributor

AlOneill commented Jul 2, 2018

@Captainkirkdawson Thanks. Still a couple of issues — will solve offline.

@Captainkirkdawson
Copy link
Member Author

Have completed marriages

@Captainkirkdawson
Copy link
Member Author

Have completed burials

@AlOneill
Copy link
Contributor

AlOneill commented Jul 2, 2018

Question: are the 2 systems, flexible and fixed, going to be used alongside each other, or does flexible replace fixed?

@Captainkirkdawson
Copy link
Member Author

@AlOneill they can and will coexist. BUT once a batch uses flexible it cannot go back

@AlOneill
Copy link
Contributor

AlOneill commented Jul 6, 2018

@Captainkirkdawson Thanks.

Next question: am puzzled by _status field — if _condition field is for marital status, what kind of status goes in the _status field? Standing wrt 'church' ?? (No examples are given in baptisms.)

@Captainkirkdawson
Copy link
Member Author

Captainkirkdawson commented Jul 6, 2018

@PatReynolds @SteveBiggs
Alison raises a great question. The reason I did not enter an example was I did not understand what the field was all about. Perhaps you can clarify.

https://test3.freereg.org.uk/cms/information-for-transcribers/entering-data-from-registers/extended-marriage-fields-draft

@SteveBiggs
Copy link
Collaborator

Sorry I don't understand the question. Which field are you asking about? Is this in marriages or baptisms?

@AlOneill
Copy link
Contributor

AlOneill commented Jul 6, 2018

@SteveBiggs I was asking about the baptism fields: person_condition and person_status

If person_condition is for recording marital status, then what goes in person_status?

https://test3.freereg.org.uk/cms/information-for-transcribers/entering-data-from-registers/extended-baptism-fields-draft#bapQ and following field

@SteveBiggs
Copy link
Collaborator

Person status - e.g. Illegitimate, Twin, etc.

@Captainkirkdawson Captainkirkdawson removed their assignment Jul 7, 2018
@PatReynolds
Copy link

@smrr723 @Captainkirkdawson any idea why the download links are failing? If no idea / not fixable, I suggest they are uploaded to the F U G website.

@smrr723
Copy link
Contributor

smrr723 commented Nov 21, 2018

Searching for "The SHA parameter you gave is incorrect" shows it's a known issue, but I don't see any single, simple solution.

@Captainkirkdawson markevans/dragonfly#387 (comment) seems to be the clearest solution I've found but from what I can see in our Gemfile, we should have the highest working version of the json gem anyway.

@Captainkirkdawson
Copy link
Member Author

@smrr723 As you likely have perhaps perceived I have not the foggiest idea of how to keep the SHA from changing. My solution would be to eliminate it totally and put a straight link to the file and ignore any complaints from dragonfly

@smrr723
Copy link
Contributor

smrr723 commented Nov 21, 2018

@Captainkirkdawson that's probably the best solution I think.

@Captainkirkdawson
Copy link
Member Author

SHA gets changed by a server restart. Testing a solution

@Captainkirkdawson
Copy link
Member Author

@AlOneill Problem has been fixed by adding a dragonfly secret code to resources. Have sanitized the initialization to use a mongo_config constant rather than hard code. SHA survives a server restart now.

@SteveBiggs
Copy link
Collaborator

Can we deploy the help info to production now?

@AlOneill
Copy link
Contributor

AlOneill commented Dec 6, 2018

There is an outstanding query about the Notes field — link is to the Baptisms page, but also applies to other record types.

See: https://test3.freereg.org.uk/cms/information-for-transcribers/flexible-csv-format-draft/extended-baptism-fields-draft#bapAN

@SteveBiggs
Copy link
Collaborator

I would say the answer is no. Leave that comment out as it could cause confusion.

@AlOneill
Copy link
Contributor

AlOneill commented Dec 7, 2018

@Captainkirkdawson Thank you — looks good.

@SteveBiggs Thank you. Will begin clean-up of new pages.

@AlOneill
Copy link
Contributor

AlOneill commented Dec 7, 2018

@Captainkirkdawson The 4 new pages are now ready for syncing, as are the other pages in the (Transcriber) Help section that required menu updates.

Please note that the edit required by #1226 has been done as part of the above.

@Captainkirkdawson
Copy link
Member Author

@PatReynolds @richpomfret @lemon-ukgen

Rather than my doing a one off would it not be far better to use this as an opportunity to have you ans lemon test the syncing task envisaged as part of #1371

@SteveBiggs
Copy link
Collaborator

When will the sync task be run? We need to get the flexible csv help onto the production site.

@richpomfret
Copy link
Contributor

@lemon-ukgen has been given the go-ahead to create the script to automate this. We will try and roll it out over the next sprint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants