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

Add tabs to the docs where possible #1785

Closed
mturoci opened this issue Jan 10, 2023 · 12 comments · Fixed by #2065
Closed

Add tabs to the docs where possible #1785

mturoci opened this issue Jan 10, 2023 · 12 comments · Fixed by #2065
Labels
docs Documentation feature Feature request good first issue Contributions welcome!

Comments

@mturoci
Copy link
Collaborator

mturoci commented Jan 10, 2023

Currently, we have a flat list of instructions (https://wave.h2o.ai/docs/installation) for all Unix/Windows or Pypi/Conda. It would be great if they could be cleaned up into corresponding tabs instead.

Pages that need this:

and possibly others.

@mturoci mturoci added docs Documentation feature Feature request good first issue Contributions welcome! labels Jan 10, 2023
@c00kie123
Copy link

Hey! I am interested in this. Assign it to me

@mturoci
Copy link
Collaborator Author

mturoci commented Jan 10, 2023

Go ahead @c00kie123!

@c00kie123
Copy link

Thanks for assigning! I am new to open-source so bear with me for a while.
I understand the requirements to build new feature of tabs.
Can I ask where should I do this change be done at in the directory?
You mentioned there are different sets of instructions for different type of software like Unix/Windows. May I know where I can find them?

Thanks for your help!!

@mturoci
Copy link
Collaborator Author

mturoci commented Jan 11, 2023

Try looking for the pages linked in the issue description. The way I do this when joining a new project is simply a global search for a specific string contained in the page. This is usually very efficient when ramping up.

@oadeniran
Copy link
Contributor

Hi @mturoci
I just wanted to confirm this is still open for me to work on, I see you made some commit to the installation doc 2 months ago but this feature still hasn't been added
I should be able to wrap it up for the 3 links provided in 2 days at least

@oadeniran
Copy link
Contributor

Also the tutorial-hello is in markdown and mot mdx format
Since the tutorial provided uses a functionality that is provided for mdx only, can I save the edited file in the mdx format

@mturoci
Copy link
Collaborator Author

mturoci commented Jun 26, 2023

Since the tutorial provided uses a functionality that is provided for mdx only, can I save the edited file in the mdx format

Sure. Thanks!

@oadeniran
Copy link
Contributor

oadeniran commented Jul 1, 2023

Hi @mturoci
I am having issues setting up the project for local dev
On windows and using wsl as a fallback and I have navigated succesfully so far following the step outlined in the readme of the my website directory but I get an error when running "make generate"
The error message says "cannot connect to wave server" and after trying to decode the Python file for the process I realized that it is an issue with go and my experience with go is limited
Any advice? as I am done with the edit to the docs but have been unable to test so far

@mturoci
Copy link
Collaborator Author

mturoci commented Jul 3, 2023

Hi @oadeniran, did you go through https://wave.h2o.ai/docs/contributing#development-setup? It's basically just installing Node, Python and Go, then running make all. Once successful, you should be good to run make generate without problems.

@oadeniran
Copy link
Contributor

Screenshot (29)
Hi @mturoci ,
I was able to successfully navigate but a change also had to be made to the makefile for the showcase folder for the last command of make setup as shown in the screenshot
Also, I realized 12 other files ( all files in the git change tracker asides the installation.mdx file and the aforementioned makefile as shown in the screenshot) were modified by the process ran by the makefiles, Do I commit them ( the changes apart from those explicitly made by me) or discard them?

@mturoci
Copy link
Collaborator Author

mturoci commented Jul 4, 2023

Thanks for being so determined, you are probably the first one running this repo against Windows :)

a change also had to be made to the makefile for the showcase folder for the last command of make setup

interesting, is this mentioned somewhere in the Playwright docs?

12 other files were modified by the process

showcaseN.py should be only temporary and deleted automatically once the make generate in showcase finishes.

All in all, you can commit everything in the PR and we can deal with it over there. The types.py, ui.py etc. should have no changes also, but I would need to see what has changed, which can be best done on the PR.

@oadeniran
Copy link
Contributor

Hi @mturoci
I think I am finally done, attached are screenshots of the tabs added to the three specified docs

Screenshot (33)
Screenshot (32)
Screenshot (31)

mturoci added a commit that referenced this issue Jul 7, 2023
Co-authored-by: oadeniran <adeniran.owolabi@imotunn.com>
Co-authored-by: Martin Turóci <64769322+mturoci@users.noreply.github.com>
mturoci added a commit that referenced this issue Aug 3, 2023
Co-authored-by: oadeniran <adeniran.owolabi@imotunn.com>
Co-authored-by: Martin Turóci <64769322+mturoci@users.noreply.github.com>
marek-mihok pushed a commit that referenced this issue Jan 15, 2024
Co-authored-by: oadeniran <adeniran.owolabi@imotunn.com>
Co-authored-by: Martin Turóci <64769322+mturoci@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation feature Feature request good first issue Contributions welcome!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants