Check and update End User documentation

[cessda-bitbucket-importer]

Original report on BitBucket by John Shepherdson (GitHub: john-shepherdson).

---

Make sure it is consistent with the features available in this release

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

Location is https://github.com/cessda/cessda.cdc.userguide

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

Include:

• info about filters and free text search
• Clickable Keywords and Topics
• Free text search is now AND

‌

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

See also #249

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

Updated images to reflect changes to UI.

Updated navigation structure.

Added advanced search examples and updated numbers to reflect current numbers of records. All examples are executable (N.B. check PRECEDENCE examples).

Added file that details new navigation structure.

[cessda-bitbucket-importer]

Original comment by Taina Jääskeläinen.

---

@john-shepherdson

I updated the User Guide google sheet.

• Addition to ‘About introduction’.
• Addition to ‘Filtered search’.

Both amendments are commented, so you can find them. And thank you for updating these, much appreciated!

‌

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

Changes made and GDoc updated

[cessda-bitbucket-importer]

Original comment by Taina Jääskeläinen.

---

@john-shepherdson One more amendment: Change the screenshot in Detailed study view to one that has the tab ‘Access data’. And click open the Access, Topic and Keywords sections for the screenshot. Perhaps this study:

https://datacatalogue-staging.cessda.eu/detail?q="NSD__http://nsddata.nsd.uib.no:80/obj/fStudy/NSD2799"

‌

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

Done

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

@‌TainaFSD Please add text for ‘Report a problem’ page

[cessda-bitbucket-importer]

Original comment by Taina Jääskeläinen.

---

I wonder whether users would click on the ‘Report a problem’ button if they have wishes or suggestions for new features or amendments. If it is improvement they want to discuss rather than report a problem? But not sure if the button has the same label in all CESSDA tools. And not sure what it could be called otherwise. ‘User feedback’? ‘Give feedback’?

Anyway, I’m included other feedback than problem reporting in my text. Text DONE.

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

New page added ‘Send feedback’. Tab renamed ‘Send feedback’. Text of feedback form modified to say ‘Please tell us what the issue is ….’

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

@‌TainaFSD Please see https://datacatalogue-staging.cessda.eu/documentation/ and report and defects here. I am aware that in the navigation, ‘Send Feedback’ has an arrow that suggests it has child pages, but none are present. I will remove that.

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

Updated made and pushed. Should be visible in staging soon.

[cessda-bitbucket-importer]

Original comment by Taina Jääskeläinen.

---

@john-shepherdson @matthew-morris-cessda

John, has the staging version of the User Guide been updated? I noticed some discrepancies in Basic search and Detailed study view sections in the UG between the most recent Google version and staging.

Some changes were visible in the ‘box’ in the UG Google doc version but not in staging

• https://docs.google.com/document/d/1XzBC65fvuNqCNhctJgDicPKqNWh0DsPucVByly9kiU0/edit#heading=h.dvb1iqwr9lyh

One paragraph was missing both from the ‘box’ and staging in Detailed study view. I may have forgotten to overshadow this, sorry!

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

Detail study view screenshot now shows infotips.

[cessda-bitbucket-importer]

Original comment by Taina Jääskeläinen.

---

Not seeing it in staging yet, image does not have infotips. I did refresh.

[cessda-bitbucket-importer]

Original comment by John Shepherdson (GitHub: john-shepherdson).

---

Maybe a caching issue. It is present in the latest version.