gbif / ipt

GBIF Integrated Publishing Toolkit (IPT)
https://www.gbif.org/ipt
Apache License 2.0
128 stars 58 forks source link

Improve documentation for Shortname on Manage IPT Tab #1090

Closed kbraak closed 9 years ago

kbraak commented 9 years ago
When creating a new resource at the bottom of the Manage Resource tab in the IPT, would
it be possible to replace the existing shortname sentence in the instructions, with
this statement included in the documentation on the wiki,

"First, a unique "shortname" must be provided for the resource. This short name will
be used to uniquely identify the resource within the IPT instance, and will be used
within the URL to access the resource via the Internet. The shortname must be at least
three characters in length, may contain alphanumeric characters, but must not contain
white space or punctuation other than hyphens or underscores (e.g., "firstresource"
or "first_resource", but not "first resource" or "firstresource!"). "

OR

could that statement be included within an information button next to the shortname
header?

Note: this recommendation stems from one manager I have on our IPT who has been setting
up and managing his own resources and database connections.  He was a first thinking
that shortname was rather inconsequential and was unaware that the shortname became
part of the URL.  He felt that more information about what shortname was upfront before
the resource is created would be helpful and I agreed with him.

Thanks.

Original issue reported on code.google.com by laura.anne.russell on 2014-06-20 19:52:17

kbraak commented 9 years ago
Thanks for reporting the issue. I agree this enhancement is needed, and we will include
it in the next release.

Original issue reported on code.google.com by kyle.braak on 2014-06-26 09:07:01

kbraak commented 9 years ago
This issue was updated by revision r4659.

Original issue reported on code.google.com by kyle.braak on 2014-10-25 17:38:59

kbraak commented 9 years ago
The create resource section has now been updated as per your suggestion Laura. A screenshot
is attached showing how it looks now. Can you please confirm this is fine? Thanks

Original issue reported on code.google.com by kyle.braak on 2014-10-25 17:40:33


kbraak commented 9 years ago
Looks good.  Thanks for adding.

Original issue reported on code.google.com by larussell@vertnet.org on 2014-10-26 06:17:08

kbraak commented 9 years ago
Great. 

It will require an update in the user manual too before closing.

Original issue reported on code.google.com by kyle.braak on 2014-11-05 12:51:33

kbraak commented 9 years ago
Translation and user manual update completed. 

Update included in create resource description: https://code.google.com/p/gbif-providertoolkit/wiki/IPT2ManualNotes#Create_a_New_Resource

Closing issue

Original issue reported on code.google.com by kyle.braak on 2015-03-20 14:02:59