-
-
Notifications
You must be signed in to change notification settings - Fork 173
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
Add prominent link to CC tools and clarify site purpose (Fixes #793) #810
Add prominent link to CC tools and clarify site purpose (Fixes #793) #810
Conversation
- Added a button linking to the Creative Commons 'Share your work' page. - Updated hero section to include comments for better code clarity. - Included explanatory text about the site's purpose for developers and general users.
- Included a new caption explaining the site's focus on developer contributions. - Added a link to Creative Commons tools in the footer for easier navigation. - Minor formatting adjustments.
- Added comments to clarify the styling for the hero section, including title, description, and links. - Improved button layout using flexbox, with comments explaining width, padding, and alignment choices. - Enhanced readability by documenting key CSS properties for future maintainability.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the direction of this PR!
Please:
- Remove "Follow us on twitter" button
- Move "Share your work using our licenses/tools" button below "This site is for developers looking to contribute, but anyone can use CC tools to share their works." text
- Update "Share your work using our licenses/tools" button to use color of now-removed Twitter button
- Update styling of "This site is for developers looking to contribute, but anyone can use CC tools to share their works." text to match "We work on code and products [...]" text
Please also remove footer notice |
I would also add the internal vertical padding for the text on the button is inconsistent with the other buttons and needs to be adjusted as well. |
Thank you for the detailed feedback! I've made the suggested updates, but I need some help on the last feedback from @possumbilities. As it's clear, the text within the button is too long. How do I go about that? Should I make the text smaller and fit it in one line, or split it into two lines like it is currently, but adjust the padding appropriately? If I make the text one line, I would need to reduce the font size to avoid the design extending horizontally, which would otherwise cause horizontal scrolling on smaller devices and impact the user experience. Could you guide me on which approach would be best? Thank you again for your time and guidance! |
@MohdMuslim92 I think the most direct solution is to correct the padding. Buttons should be able to allow text-wrapping, and grow in height without them overflowing the bounds of the button, or breaking the internal spacing. I would strongly urge against altering the font-size, that may result in poor Accessibility. A button shouldn't expect a particular length of text, though long text on buttons should have some limit (the longer it is the more disruptive it is to the button's scannability. |
…ton, updated styling and padding
Thanks again for the detailed feedback! I've made the suggested updates and pushed the changes. Please let me know if there's anything else that needs attention. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I realize, now, that we're fighting an assumption that is encoded in the Lektor model and theme template. That assumption is that there is a single paragraph in the description followed by one or more links.
The long term solution is to refactor the theme, which is beyond the scope of this PR.
A shorter term solution is to move the description into the link section so the paragraphs and buttons can be intermingled.
- modify template
--- themes/vocabulary_theme/templates/blocks/hero.html +++ themes/vocabulary_theme/templates/blocks/hero.html @@ -7,9 +7,6 @@ </div> <div class="columns margin-right-0"> <div class="column is-5"> - <p class="hero-description"> - {{ this.description }} - </p> {{ this.links }} </div> </div>
- modify content
--- content/contents.lr +++ content/contents.lr @@ -9,24 +9,18 @@ title: We have been building <span class="has-text-forest-green">free software</span> at <span class="has-text-gold">Creative Commons</span> for over a decade. ---- -description: - -We work on code and products that support digital creativity and sharing, from usability of our legal tools to enabling discovery of CC-licensed content. ----- links: -<!-- Container for the hero section links --> +<p class="hero-description">We work on code and products that support digital creativity and sharing, from usability of our legal tools to enabling discovery of CC-licensed content.</p> <div class="hero-links"> <!-- Button linking to the developer community page --> <a class="button small is-success row" href="/community"> Join the Developer Community </a> +</div> - <!-- Informational text about the purpose of the site --> - <div class = "hero-notice"> - This site is for developers looking to contribute, but anyone can use CC tools to share their works. - </div> - +<p class="hero-description">This site is for developers looking to contribute, but anyone can use CC tools to share their works.</p> +<div class="hero-links"> <!-- Button linking to the Creative Commons "Share your work" page --> <a class="button small row" href="https://creativecommons.org/share-your-work/"> Share your work using our licenses/tools
- modify styles (per code comment)
- Update PR description (ex. new screenshot)
…on styling, and refactor buttons
Hi @TimidRobot, Thank you for your feedback! I’ve made the suggested changes and updated the pull request description Please let me know if there’s anything else you’d like me to address. Looking forward to your review! Best. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work!
Thank you all for your valuable feedback and guidance throughout this PR! I really appreciate your time and help in getting this merged. Looking forward to contributing more in the future! Best regards, |
Fixes
Description
This pull request resolves an issue where users might mistakenly visit this site while looking for Creative Commons (CC) licenses/tools, which could lead to confusion about the purpose of the site.
To address this:
Technical details
content/contents.lr
to include the new button and the clarification notice on the homepage.webpack/sass/home-page.scss
to style the new button in the hero section and improve the overall layout.Screenshots
Checklist
Update index.md
).main
ormaster
).visible errors.
Developer Certificate of Origin
For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."
Developer Certificate of Origin