Skip to content

docs: Add tabs to docs where possible #1785 #2065

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
Merged
merged 12 commits into from
Jul 7, 2023
Merged

docs: Add tabs to docs where possible #1785 #2065

merged 12 commits into from
Jul 7, 2023

Conversation

@oadeniran
Copy link
Contributor

@oadeniran oadeniran commented Jul 6, 2023 •
edited by mturoci
Loading

The PR fulfills these requirements: (check all the apply)

  • It's submitted to the main branch.
  • When resolving a specific issue, it's referenced in the PR's title (e.g. feat: Add a button #xxx, where "xxx" is the issue number).
  • When resolving a specific issue, the PR description includes Closes #xxx, where "xxx" is the issue number.
  • If changes were made to ui folder, unit tests (make test) still pass.
  • New/updated tests are included

My specific changes:

  • Tutorial-hello.md renamed to Tutorial-hello.mdx
  • edits to both installation.mdx files
  • Edited the references to tutorial-hello.md and redirected to tutorial-hello.mdx (in guide, tutorial-beer, tutorial-counter, tutorial-monitor)
  • edited the setup in makefile of tools/showcase from ./venv/bin/python -m playwright install to ./venv/bin/python -m playwright install-deps
  • The other edits and additions were automatically generated

Closes #1785

@oadeniran oadeniran requested review from lo5 and mturoci as code owners July 6, 2023 00:56
@oadeniran oadeniran changed the title Documentation issue contrib: Add tabs to docs where possible - Issue #1785 Documentation issue contrib: Add tabs to docs where possible - Issue #1785, Close #1785 Jul 6, 2023
@mturoci mturoci changed the title Documentation issue contrib: Add tabs to docs where possible - Issue #1785, Close #1785 docs: Add tabs to docs where possible #1785 Jul 6, 2023
mturoci
mturoci requested changes Jul 6, 2023
View reviewed changes
Copy link
Collaborator

@mturoci mturoci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @oadeniran!

A few minor changes required. I didn't want to duplicate comments for each file so please go through my suggestions and apply them to other files as needed.

When running the Docusaurus docs, I get this warning

[WARNING] Docs markdown link couldn't be resolved: (tutorial-hello.md) in "/Users/martinturoci/go/src/github.com/h2oai/telesync/website/docs/scripts.md" for version current

@oadeniran
Copy link
Contributor Author

oadeniran commented Jul 6, 2023 •
edited
Loading

Hi @mturoci , I just Addressed all points you made in the edits and changes commit
I think the reason why the temporary files don't delete is because my "make generate" doesn't run till the end on my wsl

@mturoci
Copy link
Collaborator

mturoci commented Jul 7, 2023

I think the reason why the temporary files don't delete is because my "make generate" doesn't run till the end on my wsl

Why doesn't it run to completion? Btw, the showcase files are still part of this PR, they should not.

I just Addressed all points you made in the edits and changes commit

There are still comments from me that didn't get answered / resolved.

@oadeniran
Copy link
Contributor Author

oadeniran commented Jul 7, 2023

I think the reason why the temporary files don't delete is because my "make generate" doesn't run till the end on my wsl

Why doesn't it run to completion? Btw, the showcase files are still part of this PR, they should not.

I think it doesn't run till completion due to the inadequacies of my pc. The computing power needed for matplotlib is a bit high for the project I think and after a while my wsl just gets stuck on generating a file and never gets past that stage
I will remove them from the git history

I just Addressed all points you made in the edits and changes commit

There are still comments from me that didn't get answered / resolved.

mturoci
mturoci approved these changes Jul 7, 2023
View reviewed changes
Copy link
Collaborator

@mturoci mturoci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @oadeniran!

@mturoci mturoci merged commit c67db06 into h2oai:main Jul 7, 2023
@oadeniran
Copy link
Contributor Author

oadeniran commented Jul 7, 2023

Thanks so much for the approval @mturoci
I really learned a lot on this
i am thinking of posting this on LinkedIn and I was hoping if its possible for me to tag you on the post to thank you for the help and guidelines provided and also connect with you on linkedin at the same time

@mturoci
Copy link
Collaborator

mturoci commented Jul 7, 2023

Sure, np :) Glad you learned something.

mturoci added a commit that referenced this pull request Aug 3, 2023
@oadeniran @ade-imotunn @mturoci
docs: Add tabs to docs where possible #1785 (#2065)
bf9ee7c 
Co-authored-by: oadeniran <[email protected]>
Co-authored-by: Martin Turóci <[email protected]>
marek-mihok pushed a commit that referenced this pull request Jan 15, 2024
@oadeniran @ade-imotunn
@mturoci @marek-mihok
docs: Add tabs to docs where possible #1785 (#2065)
7af91da 
Co-authored-by: oadeniran <[email protected]>
Co-authored-by: Martin Turóci <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mturoci mturoci mturoci approved these changes

@lo5 lo5 Awaiting requested review from lo5 lo5 is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add tabs to the docs where possible

3 participants

@oadeniran @mturoci @ade-imotunn