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

Do a final sweep of all the front-end helper text/copy on CKAN 2.0 #302

Closed
johnmartin opened this issue Jan 24, 2013 · 20 comments
Closed

Do a final sweep of all the front-end helper text/copy on CKAN 2.0 #302

johnmartin opened this issue Jan 24, 2013 · 20 comments
Assignees
Milestone

Comments

@johnmartin
Copy link
Contributor

As it stands we have mixed standards for different things within the CKAN copy. I would like to suggest the following for our copy:

  • Button / pseudo-button action links text should: caps on first letter. E.g. "Create new dataset" not "Create New Dataset", "Show more tags" not "Show More Tags", etc.
  • Lists should never end in a full stop
  • Headers should be like buttons, but the context can be capitalised. E.g. "What are Organizations?" not "What are organizations?"
  • Create action links should read: "Add new group" not "Add group"
  • Form submits should read: "Update group" or "Add new group" not "Update Group" or "Add New Group"
  • Primary action buttons for a page should always have btn-primary on them. Eg: "Edit my profile" on viewing your profile page
  • ... also they should be declarative of what they are editing. E.g. "Edit my profile" not "Edit"

Also, the /about page needs updating to be something a little nicer and the footer links need pointing to the correct pages.

@ghost ghost assigned johnmartin Jan 24, 2013
@johnmartin
Copy link
Contributor Author

@shevski @mwainwright Do either of you have any thoughts on this?

@shevski
Copy link

shevski commented Jan 24, 2013

All the above is fine with me.

In terms of the about page - is this for the about text that comes with any standard installation of CKAN? @mwainwright / @darwinp do you have ideas for this?

@johnmartin what footer links are wrong?

@tobes
Copy link
Contributor

tobes commented Jan 24, 2013

@johnmartin

The ideas seem good we should add this to our dev guide somewhere maybe a new Front end style guide. Accessible consistency seems the right approach.

@shevski footer links go nowhere at the moment in core at least they are still mock design there is issue #254 for this

@shevski
Copy link

shevski commented Jan 30, 2013

On user profile page, we should not display "No full name provided" as seen here: http://beta.ckan.org/user/shevski?__no_cache__=True# instead should fallback to username

Screen Shot 2013-01-30 at 14 28 52

@shevski
Copy link

shevski commented Jan 30, 2013

Member count on Organizations is wrong (always shows '0') and should not be displayed to non-members: http://beta.ckan.org/organization/neworg

Screen Shot 2013-01-30 at 14 31 15

@shevski
Copy link

shevski commented Jan 30, 2013

On both group and organisation pages, the dataset count should be first, then the follower number
(remove 'members' completely from orgs)

Screen Shot 2013-01-30 at 14 35 46

@johnmartin
Copy link
Contributor Author

<dataset>, <organization>, etc within slug previews looks a little HTMLy. Should be ...

@johnmartin
Copy link
Contributor Author

Markdown formatting on organizations info page is not working.

@johnmartin
Copy link
Contributor Author

Organization title within activity streams should be title and not slug

@mwainwright
Copy link

Dashboard -> My datasets:
"You currently have not added any datasets yet" -> remove 'currently'

Organizations page > What are organizations:
"Organizations act like publishing departments ..." -> replace this text with

Organizations are the different bodies that publish data (for example, different government departments). Each dataset belongs to one organization.

Within each organization, admins can assign roles and authorisations to its members, controlling who can publish and edit datasets from the organization.

The above is for beta / demo. For the release version, omit the second paragraph.

@mwainwright
Copy link

Groups page > What are groups:
"Groups allow you to group together ..." -> replace with

Groups are collections of datasets. You can use them to organise data, or to build curated collections of data by theme (e.g. Transport, Health, etc).

@mwainwright
Copy link

Organization > Edit:

Edit a Organization -> Edit an Organization

(or just "Edit Organization")

@mwainwright
Copy link

My org > Edit > Members > (click spanner by name)

"Edit Member: johnmartin" ->

"Edit member: John Martin (johnmartin)"

In cases where (as here) the member has given a real name. Also note lower-case 'member'.

@mwainwright
Copy link

Dataset page > Related

"No apps, ideas, news stories or images have been related to this dataset yet, why not add one now?" ->

"This dataset has no related items yet. Why not add one?"

@mwainwright
Copy link

Create Related Item:

Type (API / Application / Idea / News Article / Paper / Post / Visualization)

This is pointless. I would delete it. I don't see the need to categorise related items, and if there is one, these ones aren't obviously the right categories.

EDIT BY IB: @mwainwright This allows for filtering on the site-wide page, although could be more obvious and not in the sidebar. To change once we add a search bar (see #333)

@mwainwright
Copy link

Also, how do I see related items? publicdata.eu has a link in the theme but we don't have one. Surely we should.

@mwainwright
Copy link

/apps : this should be called /related

EDIT: will review for 2.0

@mwainwright
Copy link

Surely to goodness adding a related item should show up on the dataset's activity stream??

EDIT IB: @mwainwright this is not a small issue. Create new issue, not for ckan beta

@mwainwright
Copy link

http://beta.ckan.org/apps

Remove "Only show featured items" checkbox

johnmartin added a commit that referenced this issue Jan 30, 2013
Basically they break down as follows:

1. Lowercased all possesive items. E.g. "Create Organization" becomes "Create organization"
2. "Add" when actually building a new object becomes "Create"
3. "Add" when linking objects becomes "Attach"
4. Primary action buttons for pages all now have `.btn-primary`
@johnmartin
Copy link
Contributor Author

I'm closing this as it's too outdated, some of these tweaks are already in master and the string freeze for 2.0 has happened. I'll put some time aside to create a new issue for 2.1 that only includes the ones that still need doing from this thread.

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

No branches or pull requests

4 participants