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

Updates to Style Guide #1677

Closed
manez opened this issue Nov 4, 2020 · 3 comments
Closed

Updates to Style Guide #1677

manez opened this issue Nov 4, 2020 · 3 comments

Comments

@manez
Copy link
Member

manez commented Nov 4, 2020

Following some discussion at the November 4th DIG meeting, I am proposing the following changes to the Style Guide:

  • A "last edited on DD-MM-YYYY" line to the end of each documentation page — or the begging? where do folks think it would be more useful? We could use <sub><sup>sup and sub text</sup></sub> to make it super tiny and less obtrusive if it goes at the top.

  • A standard "callout" and emjoi for calling attention to when Islandora practice differs from standard Drupal. As an example, we have a Managing Users page that is almost entirely vanilla Drupal, but the fedoraAdmin role is a special, Islandora-only thing, that people who are already comfortable in Drupal need to know about, even if they don't need a tutorial on the entire user management interface. This new callout would make for a standard "info box" calling out the Islandora-only thing for documentation users to scan for. It will appear as the themeless example from here. We can use any emoji, but I'm partial to ✨ 🏖️ (for the Island) or, of course 🦞

We can also have a standard call out for "Learn More" style information, where we are giving the basics in our docs, but linking out to either a more detailed page in our own docs or somewhere else on the web that goes into more depth.

@seth-shaw-unlv
Copy link
Contributor

For dates, either top or bottom works for me but please don't use the sub/sup formatting; leave it full size:

The <sub> element should be used only for typographical reasons—that is, to change the position of the text to comply with typographical conventions or standards, rather than solely for presentation or appearance purposes.

For the icon, 🦞 or ✨.

@manez
Copy link
Member Author

manez commented Nov 9, 2020

Oh, all right. No torturing the markup for tiny text

I'll get a PR ready for the style guide. Just need a few more votes on whether we sparkle or lobster.

@manez manez mentioned this issue Nov 9, 2020
7 tasks
@manez
Copy link
Member Author

manez commented Nov 18, 2020

@manez manez closed this as completed Nov 18, 2020
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

2 participants