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

Active hover tab on meshery docs #7419

Closed
sudhanshutech opened this issue Mar 29, 2023 · 26 comments · Fixed by #7831
Closed

Active hover tab on meshery docs #7419

sudhanshutech opened this issue Mar 29, 2023 · 26 comments · Fixed by #7831
Assignees
Labels
area/docs Documentation update needed good first issue Good for newcomers kind/enhancement Improvement in current feature

Comments

@sudhanshutech
Copy link
Member

Current Behavior

Currently in sidebar of meshery docs there is no active tab while we are particular section of meshery docs. It creates difficulties while surfing through docs

Recording.2023-03-30.033737.mp4

Desired Behavior

Implement a active hover link while we are in particular section or page of meshery docs. Set the current hover color active or fixed when you are still on that page of meshery docs redirected through sidebar.

Implementation

Acceptance Tests

Mockups


Contributor Guides and Handbook

@sudhanshutech sudhanshutech added kind/enhancement Improvement in current feature good first issue Good for newcomers area/docs Documentation update needed labels Mar 29, 2023
@Indira-kumar
Copy link

@sudhanshutech Can you please assign me this issue. I would like to work on it.

@sudhanshutech
Copy link
Member Author

Sure @Indira-kumar , go ahead. Need any help then let me know

@Indira-kumar
Copy link

Hi @sudhanshutech, Thank you so much.
I am new to open source, so I need a bit of time for learning the flow. But I will definitely submit the PR within a week. If I need any help I will let you know.

@rijusougata13
Copy link
Contributor

hi, are you still working on?
if not can I take the issue?

@vishalvivekm
Copy link
Member

any update @Indira-kumar ?
have you docs setup locally @rijusougata13 ?

@rijusougata13
Copy link
Contributor

Screenshot 2023-04-06 at 11 48 30 AM

For this I have a specific doubt. I see we are using same sidebar code in 20+ files. If I have to make changes do I have to replace all the files? or do we have a single file source which I can reuse? @vishalvivekm

@vishalvivekm
Copy link
Member

Screenshot 2023-04-06 at 11 48 30 AM

For this I have a specific doubt. I see we are using same sidebar code in 20+ files. If I have to make changes do I have to replace all the files? or do we have a single file source which I can reuse? @vishalvivekm

Look for docs/_includes/sidebar.html @rijusougata13
docsv0.4 and v0.5 are burried in time, no changes are to be made there. // @sudhanshutech

@Indira-kumar
Copy link

any update @Indira-kumar ? have you docs setup locally @rijusougata13 ?

Hi, I am a Windows user, so I am facing an issue ((rvm installation in WSL/Ubuntu)[https://github.com/rvm/rvm/issues/5263]) while setting up the project locally. And I realised that Ubuntu/Linux platforms are more suitable to set up Open Source projects than Windows, so I was considering moving to Ubuntu as the default OS, which might take time. In the meantime, I was trying to set up the meshery workspace in the cloud, so that I can contribute quickly. But was facing issues with that as well.

So @rijusougata13 shall go ahead, as he has already set up the docs locally.

@TheOjasSingh
Copy link

Is anyone still working on this issue?

@vishalvivekm
Copy link
Member

Is anyone still working on this issue?

Hi, thanks for commenting @TheOjasSingh,
would you like to go ahead & take up this issue? in case yes, will you please confirm if you have docs set up locally.

@TheOjasSingh
Copy link

yes but I have not set up docs locally. Can you help me set up the docs locally?

@vishalvivekm
Copy link
Member

yes but I have not set up docs locally. Can you help me set up the docs locally?

Sure @TheOjasSingh
Find the Contributing Guides : Here
for contributing to docs refer to this : Meshery-Docs contribution guide

In case you face any difficulty head over to Discuss Forum and feel free to ask for help ( Do check out the forum for similar questions as yours, as It might be possible that your question is already answered)

Once you are done setting up the docs locally, signal here will assign this issue to you.
Happy Contributing!

@TheOjasSingh
Copy link

Thank you so much 😊

@TheOjasSingh
Copy link

@vishalvivekm I have completed the setup of the docs locally.

@rijusougata13
Copy link
Contributor

hi @vishalvivekm , just have a question so what happens when we click the link in the sidebar. It actually reloads the page. So even if I add an separate class when click it reloads and remove the class.
Any other approach you suggest for this?

@vishalvivekm
Copy link
Member

hi @vishalvivekm , just have a question so what happens when we click the link in the sidebar. It actually reloads the page. So even if I add an separate class when click it reloads and remove the class. Any other approach you suggest for this?

@rijusougata13 Let's discuss this on the Websites call. Please add this as an agenda item in the meeting minutes if you would. :)

@rijusougata13
Copy link
Contributor

hi @vishalvivekm , just have a question so what happens when we click the link in the sidebar. It actually reloads the page. So even if I add an separate class when click it reloads and remove the class. Any other approach you suggest for this?

@rijusougata13 Let's discuss this on the Websites call. Please add this as an agenda item in the meeting minutes if you would. :)

sure I added there.

@vishalvivekm
Copy link
Member

@TheOjasSingh @rijusougata13 any progress folks?
Please sound off on what are the blockers on this one.
Please add this as an agenda item in the websites call's meeting minutes

@rijusougata13
Copy link
Contributor

hey!! I added that in previous meeting minutes.

@ChaudharyRaman
Copy link

Hii !! Is there any progress, I would like to work on this issue.

@sudhanshutech
Copy link
Member Author

any update @rijusougata13

@rijusougata13
Copy link
Contributor

hey @sudhanshutech , @ChaudharyRaman I faced the blocker earlier. In the above comment I put my understanding and explained the issue. Also I added this in meetings note. But not sure about whats the update.

@codesmith25103
Copy link

Hey, If this issue is still open. Can I work on it?

@vaibhav135
Copy link
Member

@sudhanshutech please assign this to me.

vaibhav135 pushed a commit to vaibhav135/meshery that referenced this issue Jun 9, 2023
Signed-off-by: vaibhav bisht <vaibhav@aus.co.in>
@ashutosh887
Copy link

@vaibhav135 @sudhanshutech

Is this issue resolved? I wanted to work if not :)

@vaibhav135
Copy link
Member

@ashutosh887 There is a PR raised for this issue. So I suggest that you look for some other issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation update needed good first issue Good for newcomers kind/enhancement Improvement in current feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

9 participants