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

[Feature] Clarify repo audience and redirect CC tool consumers to main site #466

Open
1 task done
briandominick opened this issue Jul 10, 2024 · 1 comment
Open
1 task done
Labels
📖 aspect: docs Concerns the documentation in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work

Comments

@briandominick
Copy link
Contributor

Problem

It is very unclear from the README who this codebase is for, and common public search queries may lead unsuspecting end users here while looking for licenses/tools from the main site, at which point they may decide CC is a technical utility that they cannot hope to understand. Further, even for those who think this is the repo they need to be working on, some clarity would be nice.

Description

Adda prominent note to the top of the README that declares anyone looking for CC licenses and public domain tools should go to https://creativecommons.org/share-your-work/

Add some context about who is expected to make use of this codebase in what ways, before they're submerged in all the technical stuff that follows.

Add a link to https://creativecommons.org/licenses/ (already linked in sidebar but it should be clarified that this codebase essentialy generates that page specifically).

Alternatives

I thought of converting the README to AsciiDoc so we can put a proper admonition block to get better attention, but that seems like overkill. ;-)

Implementation

  • I would be interested in implementing this feature.
@briandominick briandominick added ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🟩 priority: low Low priority and doesn't need to be rushed labels Jul 10, 2024
@TimidRobot TimidRobot added 🏁 status: ready for work Ready for work 📖 aspect: docs Concerns the documentation in the repository and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 💻 aspect: code Concerns the software code in the repository labels Jul 10, 2024
@TimidRobot
Copy link
Member

Admonition-like blocks can be done with emoji and block quotes in GitHub markdown. Horizontal rules can add additional demarcation/emphasis. Compare to Admonitions | Asciidoctor Docs:

Warning markdown:

> -----
>
> ⚠️ **WARNING**
> Wolpertingers are known to nest in server racks. Enter at your own risk.
>
> -----

Warning rendered:


⚠️ WARNING
Wolpertingers are known to nest in server racks. Enter at your own risk.


Important markdown:

> -----
>
> 🛑 **IMPORTANT**
> #### Feeding the Werewolves
> While werewolves are hardy community members, keep in mind the following dietary concerns:
> 1. They are allergic to cinnamon.
> 2. More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens.
> 3. Celery makes them sad.
>
> -----

Important rendered:


🛑 IMPORTANT

Feeding the Werewolves

While werewolves are hardy community members, keep in mind the following dietary concerns:

  1. They are allergic to cinnamon.
  2. More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens.
  3. Celery makes them sad.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 aspect: docs Concerns the documentation in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work
Projects
Status: Backlog
Development

No branches or pull requests

2 participants