search

taupilu / gbif-providertoolkit

Automatically exported from code.google.com/p/gbif-providertoolkit
0 stars 1 forks source link

A step page for explaining and choosing production mode of IPT #849

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
What feature would like to see being added to the IPT?

Cases are increasing that IPT admins set up and register resources only to find 
out they all go to the dev registry. Obviously the "production use" checkbox 
and the "i" box are not honoured. Migrating resources from the test IPT is a 
burden of data publishers, which also means more maintenance tasks on the 
Registry, and risks of introducing inconsistency. It's important to guide IPT 
admins to do it right when they install the IPT.

A possible solution is creating a new setup step page, with TWO options, hence 
"test use" and "production use", and explain the difference of these 2 options 
on the same page. So admins knows what exactly each mode does and subsequent 
maintenance tasks. It's then too obvious to ignore the option and will avoid 
possible mis-registration situations.

Original issue reported on code.google.com by b...@gbif.org on 15 Mar 2012 at 12:56

GoogleCodeExporter commented 9 years ago 
Yes I agree this would go a long way to clarifying the importance of this 
selection between test and production modes. We can aim to include this in the 
next release.

Original comment by kyle.br...@gmail.com on 15 Mar 2012 at 3:27

GoogleCodeExporter commented 9 years ago 
[deleted comment]
GoogleCodeExporter commented 9 years ago 
[deleted comment]
GoogleCodeExporter commented 9 years ago 
Changes made to setup page II in r3695 and r3696. Screenshot attached of final 
work. 

At first I implemented a separate page, but in the end I decided on reworking 
the existing setup page II in order to limit introducing new errors. 

Still needed, is internationalization (4 properties affected, 1 new, 2 updated, 
1 deleted):

admin.config.setup2.mode (added)
admin.config.setup2.welcome (updated)
admin.config.setup2.production.help (updated)
admin.config.setup2.production (deleted)

The CSS has been tested in Safari, Firefox, and Chrome with no problems. 

Please let me know what you think of the change, and if it is enough to better 
guide users during configuration.

Original comment by kyle.br...@gmail.com on 18 Mar 2012 at 8:28

Attachments:

GoogleCodeExporter commented 9 years ago

Original comment by gtuco.bt...@gmail.com on 20 Mar 2012 at 4:53

GoogleCodeExporter commented 9 years ago 
I like the idea of making the selection for either test or production explicit. 
Concerning the screenshot (picture 5.phg), I would even consider adding another 
line of text directly above the selector that makes it clear that this decision 
cannot be revised later on for a given installation ("Be aware that this 
selection is final and cannot be changed later on" or similar). Apart from 
overlooking the choice completely at present, the main misunderstanding seems 
to be that "I set it up for testing first, and when I am done with that, I 
switch to production" - it needs to be clear that "switching to production" 
will not be possible.

Original comment by ah...@gbif.org on 2 Apr 2012 at 2:57

GoogleCodeExporter commented 9 years ago 
The current text reads like explaining what are "test mode" and "production 
mode", which is technically correct. However, with Andrea's comment. I would 
like to propose the following to make the consequence of choosing mode more 
straight-forward to users, including who are not necessary aware of the 
Registry:

Now we have:
Test mode is for testing (registrations will go into a test registry)
Production mode is NOT for testing (registrations go into the GBIF Registry)

I am proposing:
IPT mode decides whether or not the hosted data resource will appear on the <a 
href="http://data.gbif.org">GBIF Data Portal</a>. Once chosen, it is not 
possible to switch.
Choose "Test" if you are evaluating IPT or running it in a training scenario. 
Registrations of data will go into the "Test" GBIF Registry. Data will NOT be 
on the Data Portal.
Choose "Production" if this IPT will publish data formally for your 
organisation. Data will be on the Data Portal.
We suggest IPT administrators at least try Test mode and understand the 
registration process, and then reinstall IPT in Production mode for formal data 
publishing.

Well a bit of long, but given the fact we already have quite some data 
resources still locked in the test registry, I think it worth to explain more 
clear on the interface.

Original comment by b...@gbif.org on 3 Jun 2012 at 7:55

GoogleCodeExporter commented 9 years ago 
After a bit of discussion with Kyle, the fact that not all registered resources 
go to the current portal. So the text could be:

IPT mode decides whether or not the hosted data resource will be indexed by 
GBIF. Once chosen, it is not possible to switch.
Choose "Test" if you are evaluating IPT or running it in a training scenario. 
Registrations of data will go into the "Test" GBIF Registry. Data will NOT be 
indexed.
Choose "Production" if this IPT will publish data formally for your 
organisation. Data will be indexed.
We suggest IPT administrators at least try Test mode and understand the 
registration process, and then reinstall IPT in Production mode for formal data 
publishing.

Although people might still ask what "being indexed" means? But at least this 
avoids the fact that at least now checklist data doesn't appear in the current 
portal.

I think it's worth to have more text in this setup II page, and not in an info 
box, as a chance to inform user about the difference of test or live registry. 
Otherwise for now we don't have any public material to explain the difference. 
It  is kind of too late that users only know this after resources are 
registered to the test registry and are explained by us via email.

Original comment by b...@gbif.org on 8 Jun 2012 at 11:50

GoogleCodeExporter commented 9 years ago

Original comment by kyle.br...@gmail.com on 7 Aug 2012 at 8:43

GoogleCodeExporter commented 9 years ago

Original comment by kyle.br...@gmail.com on 7 Aug 2012 at 9:11

GoogleCodeExporter commented 9 years ago 
I have completed a new version of the setup page taking the above suggestions 
into consideration. Please take a look at the attached screenshot. The changes 
have been committed in r3927. If there are no further amendments, I will close 
this issue.

The following terms all need to be added/updated across Spanish, French, and 
Chinese:

admin.config.setup2.welcome 
admin.config.setup2.administrator
admin.config.setup2.administrator.help
admin.config.setup2.mode 
admin.config.setup2.mode.title
admin.config.setup2.mode.help 
admin.config.setup2.mode.test 
admin.config.setup2.mode.production 

The following term may need to be deleted across the other languages:

admin.config.setup2.production (deleted)

Original comment by kyle.br...@gmail.com on 8 Aug 2012 at 9:23

Attachments:

GoogleCodeExporter commented 9 years ago 
Last change to english translation made in r3929. Translation into other 
languages can now commence.

Original comment by kyle.br...@gmail.com on 8 Aug 2012 at 12:28

GoogleCodeExporter commented 9 years ago 
Spanish keys added in r3930. Final review still needed.

Original comment by kyle.br...@gmail.com on 8 Aug 2012 at 1:49

GoogleCodeExporter commented 9 years ago 
French keys added in r3932. Final review still needed.

Original comment by kyle.br...@gmail.com on 8 Aug 2012 at 2:43

GoogleCodeExporter commented 9 years ago

Original comment by kyle.br...@gmail.com on 8 Aug 2012 at 3:15

GoogleCodeExporter commented 9 years ago 
Final French translation added in r3935 - thanks Nicolas.

Original comment by kyle.br...@gmail.com on 9 Aug 2012 at 8:23

GoogleCodeExporter commented 9 years ago 
Spanish translation added in r3937  - thanks Laura and Dairo

Original comment by daniel.amariles88 on 9 Aug 2012 at 12:39

GoogleCodeExporter commented 9 years ago 
Traditional Chinese translation reviewed and added in r3968.

Original comment by b...@gbif.org on 23 Aug 2012 at 6:44

GoogleCodeExporter commented 9 years ago 
Fantastic. Thanks to the translators for the fine work. I'll now close this 
issue.

Original comment by kyle.br...@gmail.com on 24 Aug 2012 at 10:20

GoogleCodeExporter commented 9 years ago 
Reopening. User manual change still needed.

Original comment by kyle.br...@gmail.com on 20 Sep 2012 at 12:13

GoogleCodeExporter commented 9 years ago

Original comment by kyle.br...@gmail.com on 20 Sep 2012 at 12:14

GoogleCodeExporter commented 9 years ago 
This issue was updated by revision r4135.

Original comment by kyle.br...@gmail.com on 3 Oct 2012 at 3:40

GoogleCodeExporter commented 9 years ago 
All changes for this issue required for the User Manual have been committed in 
r4135. Marking issue as fixed. Please don't forget to update Spanish User 
manual.

Original comment by kyle.br...@gmail.com on 4 Oct 2012 at 10:50

GoogleCodeExporter commented 9 years ago

Original comment by kyle.br...@gmail.com on 8 Oct 2012 at 6:53