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.

Sign up for GitHub

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

Jump to bottom

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

Open
Tracked by #251
harshad16 opened this issue Aug 30, 2022 · 9 comments
Open
Tracked by #251

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

harshad16 opened this issue Aug 30, 2022 · 9 comments
Assignees
@Gkrumbach07
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@harshad16
Copy link
Member

harshad16 commented Aug 30, 2022 •
edited by goern
Loading

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

  • Make it easier for new users to find out what fits their needs.

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

#330
thoth-station/kebechet#1054

Acceptance Criteria

TBD

References

https://docs.google.com/presentation/d/17a9DSgdEUftiF2ed07zdUJbfXQ3xNxeiLZL8TBA7hhk/edit#slide=id.p
@harshad16 harshad16 added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 30, 2022
@sesheta sesheta added the needs-triage Indicates an issue or PR lacks a `triage/...` label and requires one. label Aug 30, 2022
@sesheta
Copy link
Member

sesheta commented Aug 30, 2022

@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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@VannTen
Copy link
Member

VannTen commented Aug 31, 2022

/sig user-experience
/kind documentation

@sesheta sesheta added sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. kind/documentation Categorizes issue or PR as related to documentation. and removed needs-sig labels Aug 31, 2022
@VannTen
Copy link
Member

VannTen commented Aug 31, 2022

/remove-kind feature

@sesheta sesheta removed the kind/feature Categorizes issue or PR as related to a new feature. label Aug 31, 2022
@KPostOffice
Copy link
Member

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

@KPostOffice KPostOffice added the triage/needs-information Indicates an issue needs more information in order to work on it. label Sep 14, 2022
@harshad16
Copy link
Member Author

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

  • Kebechet
  • Thoth Advise Recommendation
  • AICoE-CI
  • Elyra-devsecops
  • Thoth Precommit
  • Thoth Github Action
  • Jupyterhub Notebook image
  • Jupyterlab-requirements plugin
  • Amun-api

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 Gkrumbach07 mentioned this issue Sep 20, 2022
Open
7 tasks
@Gkrumbach07
Copy link
Member

Gkrumbach07 commented Sep 27, 2022 •
edited
Loading

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

@Gkrumbach07 Gkrumbach07 changed the title Documentation start with simple description of thoth-station projects [8pt] Documentation start with simple description of thoth-station projects Sep 27, 2022
@Gkrumbach07 Gkrumbach07 added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed triage/needs-information Indicates an issue needs more information in order to work on it. needs-triage Indicates an issue or PR lacks a `triage/...` label and requires one. labels Sep 27, 2022
@Gkrumbach07 Gkrumbach07 mentioned this issue Sep 29, 2022
Open
@Gkrumbach07 Gkrumbach07 changed the title [8pt] Documentation start with simple description of thoth-station projects Documentation start with simple description of thoth-station projects Nov 7, 2022
@harshad16
Copy link
Member Author

Related-to: thoth-station/thoth-station.github.io#245

@codificat
Copy link
Member

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: thoth-station/thoth-station.github.io#245)

@Gkrumbach07 Gkrumbach07 mentioned this issue Jan 19, 2023
Open
8 tasks
@Gkrumbach07
Copy link
Member

Gkrumbach07 commented Jan 19, 2023 •
edited
Loading

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

  • Come up with project summaries
  • Find a hierarchical list of projects

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Gkrumbach07 Gkrumbach07

Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Planning Board
Status: 📋 Backlog
Milestone
No milestone
Development

No branches or pull requests
6 participants
@codificat @Gkrumbach07 @VannTen @harshad16 @KPostOffice @sesheta