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

[SPIKE] Convert Thoth website to a Gatsby site #245

Open
2 tasks
Tracked by #250
Gkrumbach07 opened this issue Jun 13, 2022 · 8 comments
Open
2 tasks
Tracked by #250

[SPIKE] Convert Thoth website to a Gatsby site #245

Gkrumbach07 opened this issue Jun 13, 2022 · 8 comments
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries.

Comments

@Gkrumbach07
Copy link
Member

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)
@Gkrumbach07 Gkrumbach07 added the kind/feature Categorizes issue or PR as related to a new feature. label Jun 13, 2022
@Gkrumbach07
Copy link
Member Author

/sig user-experience
/priority backlog
/good-first-issue

@sesheta
Copy link
Member

sesheta commented Jun 13, 2022

@Gkrumbach07:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/sig user-experience
/priority backlog
/good-first-issue

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.

@sesheta sesheta added sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. priority/backlog Higher priority than priority/awaiting-more-evidence. labels Jun 13, 2022
@Gkrumbach07 Gkrumbach07 added this to Backlog in SIG-User-Experience Jun 15, 2022
@Gkrumbach07
Copy link
Member Author

/assign @shreekarSS
/lifecycle active

@sesheta sesheta added the lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. label Jul 5, 2022
@Gkrumbach07 Gkrumbach07 moved this from Backlog to EPICs in SIG-User-Experience Jul 5, 2022
@Gkrumbach07 Gkrumbach07 moved this from EPICs to Next in SIG-User-Experience Jul 5, 2022
@Gkrumbach07 Gkrumbach07 moved this from Next to In progress in SIG-User-Experience Jul 5, 2022
@Gkrumbach07
Copy link
Member Author

Documentation uses a combination of bots, sphinx, and swagger-codegen. To integrate Thoth website docs into a gtasby site, we would need to write a script similer to the one made in the bot.

The end goal is to replicate what was done on the Thoth Help site, or add enough styling and navigational components to the docs so that it feels seamless with the main website.

Issue will be an epic if done.

/close

@sesheta
Copy link
Member

sesheta commented Jul 14, 2022

@Gkrumbach07: Closing this issue.

In response to this:

Documentation uses a combination of bots, sphinx, and swagger-codegen. To integrate Thoth website docs into a gtasby site, we would need to write a script similer to the one made in the bot.

The end goal is to replicate what was done on the Thoth Help site, or add enough styling and navigational components to the docs so that it feels seamless with the main website.

Issue will be an epic if done.

/close

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.

@codificat
Copy link
Member

/reopen
after the discussion in today's tech talk

@sesheta
Copy link
Member

sesheta commented Nov 10, 2022

@codificat: Reopened this issue.

In response to this:

/reopen
after the discussion in today's tech talk

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.

@Gkrumbach07
Copy link
Member Author

Decided web technologies used:

  • Gatsby (React framework)
  • MUI Joy (theme and component library)
  • Storybooks and Chromatic (UI Testing, UI docs, UI CI/CD)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries.
Projects
Status: 🏗 In progress
Development

No branches or pull requests

4 participants