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

Add value propositions on documentation front page #220

Closed
Tracked by #159
chrisdburr opened this issue Aug 17, 2023 · 14 comments
Closed
Tracked by #159

Add value propositions on documentation front page #220

chrisdburr opened this issue Aug 17, 2023 · 14 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@chrisdburr
Copy link
Collaborator

chrisdburr commented Aug 17, 2023

Here are some draft value propositions that can be used for the documentation and guidance site (e.g. on homepage).

TEA Value Propositions

  • TEA platform is designed to scaffold an open and inclusive community of practice for the trustworthy and ethical design, development, and deployment of data-driven technologies.
  • Sharing and communication of assurance cases through the TEA repository helps build shared best practices and standards for operationalising principles, such as sustainability, accountability, fairness, explainability, and responsible data stewardship.
  • Our accessible and standardised assurance methodology, supported by clear user guidance and resources, contributes to building a more robust and sustainable assurance ecosystem.
  • The platform comprises a responsible research and innovation (RRI) tool for developing assurance cases, a methodology and user guidance to scaffold this process, and a community-driven repository for sharing best practices.
  • Instructions and support for self-hosted deployment are available through our documentation site for those who may need to manage sensitive information in a private environment.
  • Freely available skills and training resources help build capacity for a more inclusive and fit-for-purpose assurance ecosystem.

They can also be used in slide decks and other forms of communication.

@chrisdburr chrisdburr added the help wanted Extra attention is needed label Aug 17, 2023
@chrisdburr chrisdburr added this to Needs more info in Assurance Platform Development tracking via automation Aug 17, 2023
@kallewesterling
Copy link
Collaborator

Great drafts, Chris. I think, for accessibility reasons, let's expand the RRI to "Responsible Research and Innovation".

@chrisdburr
Copy link
Collaborator Author

As an idea for a possible use case, see the homepage of the static-site generator we use: https://squidfunk.github.io/mkdocs-material/

The homepage has simple propositions about the theme, which could be replicated on our homepage

Screenshot 2023-08-17 at 10 08 42

@kallewesterling
Copy link
Collaborator

@chrisdburr I am curious what we can do with this issue. I'd consider the value propositions reviewed now, what do we do next? Do we implement these in the documentation, the way that you've suggested in your comment above?

@kallewesterling
Copy link
Collaborator

Adding documentation tag on this issue, as it's separate from what we want our UX researchers + external devs to be working on.

@kallewesterling kallewesterling added the documentation Improvements or additions to documentation label Nov 6, 2023
@chrisdburr
Copy link
Collaborator Author

It would be helpful to have these statements (or more likely a subset of them) on the homepage of the platform, but this requires a new layout for the homepage first.

@kallewesterling
Copy link
Collaborator

Then, it seems like we might want to open a separate issue about remaking the homepage of the platform, for which this can be a subissue or at least have the new issue as a dependency. Does that seem right @chrisdburr ?

@chrisdburr chrisdburr mentioned this issue Nov 21, 2023
3 tasks
@chrisdburr
Copy link
Collaborator Author

Then, it seems like we might want to open a separate issue about remaking the homepage of the platform, for which this can be a subissue or at least have the new issue as a dependency. Does that seem right @chrisdburr ?

Agreed. New issue has been created (see #302)

@kallewesterling kallewesterling changed the title Review value propositions for use on documentation and guidance site Add value propositions on documentation front page Nov 24, 2023
@kallewesterling
Copy link
Collaborator

Moved to "In review" as this issue is all ready, just waiting for #302 (a new front page where we can add the content).

@chrisdburr
Copy link
Collaborator Author

@RichGriff, please could you share the homepage design you had, so @kallewesterling and I can put together some copy based on your layout and identify whether new graphics will be needed?

@RichGriff
Copy link
Collaborator

RichGriff commented Apr 25, 2024

Sure no problem, when running the application you navigate to /landing this will redirect you to the example page. @kallewesterling any issues please let me know.

@kallewesterling
Copy link
Collaborator

First sketch done. I am working on filling these with actual content, but quickly:

  • I think we should keep all the elements of the page for now, except:
    • Cut the "Menu" as this landing page will be enough for now.
    • I think the Login part on the top right of the page should be a very clear and colourful Call to Action button
    • The "social button" bar on the bottom should have two links: one to the GitHub repo and the other to the Documentation site.
    • I am wondering if we want to CC license this page as well.

image

@kallewesterling
Copy link
Collaborator

I have created a draft of the front page in Figma and here's the first draft:

first-draft

@chrisdburr I suggest we revisit this as early as possible next week.

@kallewesterling
Copy link
Collaborator

@chrisdburr Do you think this issue is worth closing now? Have we "added value proposition on documentation front page"?

@chrisdburr
Copy link
Collaborator Author

Yep. Looks like they're all there.

Assurance Platform Development tracking automation moved this from Needs more info to Done Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Development

No branches or pull requests

6 participants