Giter VIP home page Giter VIP logo

thoth-station.github.io's Introduction

thoth-station.github.io

Project Thoth website ================

How to contribute

Parts of the Thoth website are built using Jekyll via a GitHub action. Jekyll is configured to read markdown files from the _j directory and render them in a Jekyll theme. Jekyll also renders a few other markdown files:

  • 404.html
  • home.markdown
  • justifications.markdown
  • recommendation_types.markdown
  • helm-charts/README.md

The rest of the website is generated using Hugo where the main index.html file provides linkage to both internal and external pages.

Follow the guidelines outlined the thoth-station core repository to make a contribution.

thoth-station.github.io's People

Contributors

codificat avatar fridex avatar gkrumbach07 avatar goern avatar harshad16 avatar kpostoffice avatar mayacostantini avatar saisankargochhayat avatar sesheta avatar tlegen-k avatar vannten avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

thoth-station.github.io's Issues

Create a all projects page

As a visiter of Thoth's website, I want to be able to see all of the projects offered by Thoth so that I can explore what I might use or contribute to.

Acceptance Criteria

  • Create a all projects page (see https://www.redhat.com/en/technologies/all-products for general layout)
  • route should be /projects
  • data should be pulled from markdown files using Gastby just like #253
  • Page can have a side navigation panel for jumping to sections of the page. This is only if we plan on grouping projects into categories.

Add list of Project cards

As a developer of Thoth projects, I want to be able to update the details on our website through markdown files and not directly editing HTML.

Note: this issue does not include populating the project markdown files

Acceptance Criteria

  • Create a reusable card component that can take varying levels of detail
  • Connect the card inputs to markdown files read by Gastby
    • There should be a sub folder in this repo that defines the different projects
    • Each project has its own .mdx file
    • use the markdown frontmatter to define variables:
      • title
      • short_summary
      • software_stack
      • github_url
      • group
      • pinned_project
      • any others that would help ...
    • The rest of the document can be used to define the rest of the details describing the project
      • long summary
      • examples
      • getting started
      • etc.
  • Add the cards to the home page

More Detail
image

Less Detail
image

Card extra details

  • Cards can be separated by type
  • Cards should be sorted by most used
  • Cards can include bulleted points to help guide user to their use case (see figma)
  • Cards can have link to github page
  • Cards should link to detail page i.e. thoth-station.ninja/projects/{project_name}

Thoth documentation and website style sync and refresh

Is your feature request related to a problem? Please describe.
As a potential new user or contributor of Thoth, I want to be visually guided to a solution right from the main website.

The Thoth website does not direct users in an optimal way. Some users have reported getting lost between the many websites in the Thoth ecosystem to find the right documentation.

Describe the solution you'd like
Rewrite the website using a React framework, define are more modern UX design that directs users to a solution directly, and unify the styling between the documentation, website, and other Thoth related sites.

Additional context

Acceptance Criteria

  • #245
  • #251
  • restyle the documentation to match website styling

Create a `/projects/{project_name}` template page

As a visiter of Thoth's website, I want to be able to read up on everything related to a project from one page so I don't have to bounce around to different pages to find what Im looking for.

These pages will essentially be landing pages for a specific project. We want to either include directly or as links for installation, docs, contribution guidelines and instructions. We also can include features and other details. Many SaaS sites will have a home page for each project (or major project). Including all the elements used in the home screen: hero header, features, why this product section, user stories. See this red hat product page as notice it looks like a company home page

Our goal in this issue is to create a template component in Gatsby that can generate a consistent style for a project page while still allowing customization per product. This will require creating a few reusable components that can be defined in an mdx file.

Any project specific components can be used if need be. They will need (not need but its a better practice) to be placed in a custom project folder to signify they are specific to a project page: src/components/project/{project_name}/{component_name}

Acceptance Criiteria

  • A template React component that uses data from a project mdx file.
  • It will read frontmatter data and then render the rest of the markdown body
    • mdx allows you to place react components in the markdown file directly (sauce)
  • Include a section for showcasing the stack of the project (using frontmatter vars as the list of software)

Note: this issue does not include creating custom components for each project. This is just creating the template and structure for future issues

Introduce the google analytics 4 for universal analytics

Is your feature request related to a problem? Please describe.
Google Analytics is moving to version 4 and going to deprecate the current method of analysis.
https://blog.google/products/marketingplatform/analytics/prepare-for-future-with-google-analytics-4/?utm_campaign=2022-q1-gbl-all-gafree&utm_source=google-growth&utm_medium=email&utm_content=ga-deprecation-comm-ua-only

It is been advised to move to google analytics 4.

Describe the solution you'd like
Following the setup to update to new analytics.

Describe alternatives you've considered
Find a different tracking tool.

Add new nav bar to Gastby site

As a visiter of Thoth website, I don't want to be overwhelmed by an extensive nav bar, however I still want to be able to navigate to most of Thoths pages through links.

Acceptance Criteria

  • Reduce the number of links on top to only Projects, Community, Resources, Documentation
  • Each link can dropdown into a list of other links. i.e. Resources can hold most of the links that were on the current nav bar
  • add Thoth logo that links back to homepage on left side of the nav bar
  • Call to action should link to our getting started docs

Additional Info
Nav Bar mockup
image

Drop down can display links in a multi column modal
image

Write a resolution story to describe what Thoth does

As a visiter of Thoth's website I want to learn about what Thoth is and why it exists in a short summary.

Acceptance Criteria

  • write a summary about Thoth's dependency resolution story and why it is needed
  • place summary on Thoth's home page
  • Reuse elements from https://thoth-station.ninja/ "How we help developers" and place them in the new site

Mockup
image

[SPIKE] Convert Thoth website to a Gatsby site

Is your feature request related to a problem? Please describe.
As a Thoth user, I want all Thoth related sites to have the same UI and share navigation to make the Thoth sites feel more uniform.

Describe the solution you'd like
Convert the Thoth site and its content to a Gatsby JS site and have better navigation for the documentation.

Additional context

Gastby can be used to pull markdown files (or any other files), format them, and render them in a consistent way using React. Operate First's old website did this and their new site also uses Gatsby but doesn't pull markdown data.

Acceptance Criteria

  • Gatsby site looks like Thoths current website in terms of formatting, color, structure.
  • Gastby site renders documentation using Gastby nodes (see Thoth help page and old operate first site for implementation)

Add hero header to home page

As a visiter to Thoth's website, I want to be get an idea of what Thoth is right away by looking at the website's hero header.

Acceptance Criteria

  • Create new graphic that embodies what Thoth is to draw attention
    • This could be the terminal window with the output of the command thamos advise
    • This could be something else entirely
  • Call to action should link to the first spot we want all users to go to.
    • There can multiple call to actions but no more than 2-3
    • usually a getting started button is used
    • possibly take this topic to a Tech Talk

Examples of hero headers
image
Notice they have 3 calls to action. Their first button takes them to a getting started docs page which then seperates the user into different types based on their needs

image

Notice this hero header allows user to directly copy a terminal command to "get started"

Possible Thoth hero header
image

[1pt] Add contributing guidelines

Is your feature request related to a problem? Please describe.

I could not find a description of how the site is built and guidelines to contribute to it.

Describe the solution you'd like

Ideally there should be documentation in the repo that explains:

  1. How is the static website built. Jekyll, right? but there are references to Hugo and Pelican as well
  2. How to contribute, with some best practices

Describe alternatives you've considered

Additionally, from an initial review of the contents of the repo, there seems to be content that is not actually used (categories? tags?...), and in that case it would be better to clean things up.

Additional context

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.