search

thoth-station / core

Using Artificial Intelligence to analyse and recommend Software Stacks for Artificial Intelligence applications.
https://thoth-station.github.io/
GNU General Public License v3.0
28 stars 25 forks source link

Documentation start with simple description of thoth-station projects #451

Open harshad16 opened 2 years ago

harshad16 commented 2 years ago

Problem statement

As a User of thoth-station projects/products, it feels that too many clicks are to be done, to figure out each project of thoth-station, lets have a simple start catalog page with all MVP of thoth-station so it is easier to begin the journey with thoth-station.

we should have our start page on the documentation website and GitHub website with a list of projects/products from vast thoth-station relm, with a simple link for installation,user-guide, examples/demo.

High-level Goals

Proposal description

Update these page with list of projects and examples.

https://github.com/thoth-station/.github/blob/main/profile/README.md https://github.com/thoth-station/thoth-station.github.io/blob/master/index.html https://github.com/thoth-station/help/blob/master/content/index.mdx

Alternatives

Update the readme of one of repos with all these details and point users to there.

Additional context

https://github.com/thoth-station/core/issues/330 https://github.com/thoth-station/kebechet/issues/1054

Acceptance Criteria

TBD

References

https://docs.google.com/presentation/d/17a9DSgdEUftiF2ed07zdUJbfXQ3xNxeiLZL8TBA7hhk/edit#slide=id.p

sesheta commented 2 years ago

@harshad16: This issue is currently awaiting triage. If a refinement session determines this is a relevant issue, it will accept the issue by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
VannTen commented 2 years ago

/sig user-experience /kind documentation

VannTen commented 2 years ago

/remove-kind feature

KPostOffice commented 2 years ago

What projects/products do you want to give short blurbs?

harshad16 commented 2 years ago

We should have somewhere description of list of projects/product we have from team thoth-station:

we have these many projects/services worked and available However , we dont list them in one place, people have to look around to find these bits we should have them described somewhere or atleast on our Github Readme

Gkrumbach07 commented 2 years ago

Acceptance Criteria - [ ] Create a markdown file to store the project summaries. It could live here - [ ] markdown file should list each project as headers and include: summary, who its for, where to find it, where to contribute, how to use it / examples or links to examples. - [ ] Add links to the help sites project list from the website and documentation site

harshad16 commented 2 years ago

Related-to: https://github.com/thoth-station/thoth-station.github.io/issues/245

codificat commented 2 years ago

Discussed in the Thoth Tech Talk 2022-11-10.

Summary of the discussion is that this project overview should be part of a website revamp (related: https://github.com/thoth-station/thoth-station.github.io/issues/245)

Gkrumbach07 commented 1 year ago

We can start placing relevant info in the list of projects at the bottom of this doc. PLease add additional projects that are not listed.

Acceptance Criteria