docs site version name (label) display in url and also in dropdown of versions

[devopstoday11]

explained the issue here - https://www.loom.com/share/79a5434464b24c87a29a34305178acb8 @tfsojon

Currently for the latest version of docs - the URL is like this https://docs.intelops.ai/1.0.0/compage/1-docs-structure/ For the latest version docs only - the URL should have the version name in it instead of the version number, something like this https://docs.intelops.ai/latest/compage/1-docs-structure/

label parameter I explained in the video - new parameters to use for latest version doc in .md file : - version_name: "latest" display_version_name: "true"

[devopstoday11]

@tfsojon

[tfsojon]

Sorry I forget to respond, but started working on it form morning

[tfsojon]

@devopstoday11 website issue fixed. but this one quite unusual to implement in Hugo also on our doc-system. I already spend 2+ hrs to figure this out with Hugo's function. We can not do this without changing the folder name (like 1.0.0 to latest). but it also need lot more fixes across the site.

The main problem you mention is url issue from social media. I hope I got another solution. Will implement by tomorrow.

[tfsojon]

Now we have to update the latestDocVersion in two places

1. in config.toml - https://github.com/tfsojon/external-docs/blob/chandu/config.toml#L40
2. in netlify.toml - https://github.com/tfsojon/external-docs/blob/chandu/netlify.toml#L11

check this url - https://tf-intelops-docs.netlify.app/1.0.1/compage/6-contribution/ if you are in latest version of doc and click on copy-icon, it will copy the link with latest name

and try that copied link in a new tab.

https://github.com/intelops/external-docs/assets/87603786/e0593e2e-4359-4ae6-a932-1507be0b5b50

[tfsojon]

@devopstoday11 did you checked this?

[devopstoday11]

@devopstoday11 did you checked this?

sorry, I just checked this. Please resubmit PR to chandu branch. I want to check in my local before merging to main branch. @tfsojon

[tfsojon]

@devopstoday11 Submitted new PR. sorry for the previous PR.

[devopstoday11]

@tfsojon I observed one issue in the docs site. When you are inside a particular topic related documentation, and when you click on the version drop down and select a version it is taking me to docs site home page instead of staying within the same page where I am currently. When I change the version, I should still be within the same topic related documentation but related to whatever the version number I selected. Don't necessarily need to be on same exact page, but should be routed to same topic's first page instead of routing to docs site home page.

https://loom.com/share/59c66ba7a05d43bab23c072de52fa8c5

[tfsojon]

Ok, will do something with this.

[tfsojon]

@tfsojon I observed one issue in the docs site. When you are inside a particular topic related documentation...

https://loom.com/share/59c66ba7a05d43bab23c072de52fa8c5

@devopstoday11 updated - https://tf-intelops-docs.netlify.app/1.0.0/compage/3-installation/

[devopstoday11]

@tfsojon , yes that is what I wanted. Awesome. Thank you.

[devopstoday11]

@tfsojon @tfsumon , need modifications to the versioning feature in the Docs site. Currently, the version (for example 1.0.0) is common for every topic. That is causing some conflicts to manage the versions properly for each topic independently. I think each topic should have it's own version.

This is how topics are arranged currently in the Docs site code base - content > version-number > topic Need to change this to - content > topic-name > version numbers (folders for each version e.g: 1.0.0 , 1.0.1 , 1.0.2 , 1.0.3 , etc.)

So in the UI when the docs site is launched, there is no need to have a single global version for all topics, which is what currently is. We a visitor clicks on a certain topic and when the relevant Topic's documentation page is opened, there that Topic's version should be should in the drop down (latest, 1.0.1, 1.0.0, etc.). When you make this new update to the versioning feature, make sure the "latest in the URL" launches the latest version which was developed by @tfsojon as mentioned in this comment. So, basically, the same "latest" functionality should be available independently for each topic since that is the change I asked for the actual versioning too.

[devopstoday11]

@tfsumon please make this above change as priority. If you need clarity on it, please get insights from @tfsojon

[devopstoday11]

Requirement explained in this video

@tfsumon just for reference as explained in video :

content >
    changelog >
        compage > 
            version_number 

content >
    compage >
        version_number 

Here example topic is Compage 

[devopstoday11]

@tfsumon , update on this?

[tfsumon]

Hello @devopstoday11!

I'm currently working on resolving issue #252 within the IntelOps website repository. Once I've completed this ongoing task, my next focus will be on resolving this issue - https://github.com/intelops/website/issues/252

Please be aware that task #29 will require a significant amount of time and effort. It involves restructuring the entire content of the website and modifying the Hugo code that handles content based on various conditions.

[devopstoday11]

@tfsumon , got it. Just asking, have you started any work on this https://github.com/intelops/external-docs/issues/29#issuecomment-1723816380 already or you will start it after finishing website related task #252?

Let me know if you have started this modification task - https://github.com/intelops/external-docs/issues/29#issuecomment-1723816380 or not. I need to plan accordingly. If you haven't started I can assign this to my internal developer if anyone is free otherwise I can still leave it assigned to you. This is a priority, blocking the publishing of our new docs.

[tfsumon]

I will start it after finishing website related task #252.

[devopstoday11]

I will start it after finishing website related task #252.

oh ok.
Any ETA on the website task #252 ? @tfsumon

[devopstoday11]

I will start it after finishing website related task #252.

oh ok. Any ETA on the website task #252 ? @tfsumon

@tfsumon ?

[tfsumon]

My apologies for the delay response. Issue #252 is almost done. I'll begin working on issue #29 starting on Tuesday, October 10th and it's estimated to take about 3 weeks to complete.

[devopstoday11]

My apologies for the delay response. Issue #252 is almost done. I'll begin working on issue #29 starting on Tuesday, October 10th and it's estimated to take about 3 weeks to complete.

I disagree with 3 week's timeline. @tfsumon The original implementation for that feature was done in less than 2 days by Sojon. To modify an existing feature, why would it take 3 weeks? @tfsumon @tfsojon , could you help here please?

[devopstoday11]

@tfsumon , Did you talk to Mehedi and internal team members? What's the new ETA on this task?

[tfsumon]

Sure, I've talked to my team, and I'll have it ready for you by October 18th, within a week.

[tfsumon]

Hello @devopstoday11!

I've made some modifications to the versioning feature and created a PR #71. Could you please review it and provide your feedback? Thank you!

[devopstoday11]

Hello @devopstoday11!

I've made some modifications to the versioning feature and created a PR #71. Could you please review it and provide your feedback? Thank you!

@tfsumon check this please - https://github.com/intelops/external-docs/pull/71#issuecomment-1767451511

[tfsumon]

@devopstoday11

Fixed Conflict Remove .DS_Store from everywhere

Please check latest Pr #73

[devopstoday11]

@tfsumon , I found a major issue after merging your PR. I didn't merge it into main branch yet. I merged only to my "chandu" branch. Tested in my local :- For any topic, the content is showing up when I ran the site in my local. Because the topic has multiple version-number folders in it. For any topic, the content is not showing up when I ran the site in my local. Because the topic has only one version-number folder. --- This should also work by default, because a project may not have multiple versions in the beginning or a new project will only have 1 version in the beginning. Restricting the site rendering only when there are multiple versions and hiding the docs for the topics which has only one version folder doesn't make sense at all.

[devopstoday11]

@tfsumon , I observed one more issue. For the topic "capten" even when I added multiple version folder, still capten is not showing. Why?

[devopstoday11]

@tfsumon , please do more efficient testing. every Topic is behaving different. As of now only Kubviz topic content is showing ; nothing else is showing no matter what folder structures I tried for the others. I doubt Kubviz is also going to work if I modify anything in it.

[tfsumon]

To make this folder visible, ensure that you include version and set draft to false.

[devopstoday11]

To make this folder visible, ensure that you include version and set draft to false.

I tried that already, still didn't work. @tfsumon

I pushed my local changes to my branch "chandu". Take the code from there. That branch has the new structure functionality you provided and the folders I played with. Use it to do your testing please.
Please test very aggressively, all scenarios. @tfsumon

[tfsumon]

Okay, thank you for your clarification. I'm thoroughly reviewing it to the best of my ability.

[tfsumon]

Hello @devopstoday11,

I would appreciate some clarification on the following questions:

• For the homepage, should it display all topics based on the version specified in the config.toml file, or should it prioritize displaying the latest version? For instance, if the 'capten' topic has two versions, 0.0.1 and 0.0.2, should the homepage show the latest version (0.0.2)?
• Do the same conditions that apply to the homepage's display also apply to dropdown topics?

I kindly request your insights on these matters.

[tfsumon]

If it's possible, creating a video to explain these points would help me understand better. Your visual explanation would be really useful.

[devopstoday11]

@tfsumon ,

"For now, page url will be copied as as they are. In the future, if I find a suitable solution, I will implement it." -- this we still need it since we have to update the URL in several other areas where we use docs links in marketing materials and social media postings.

@tfsojon has done this in previous versioning implementations. Please talk to him about how he did that and take the same approach.

Other things are looking fine so far. Thank you. @tfsumon

[tfsumon]

Sojon used Netlify to redirect users, but in that case, the 'latest_version' was the same, which made it feasible.

However, I've got a solution . I'll work on implementing it today and will keep you updated.

[tfsumon]

Hello @devopstoday11 !

I've implemented the most recent changes and submitted a PR

Kindly review it and provide your feedback. Thank you!

[devopstoday11]

Hello @devopstoday11 !

I've implemented the most recent changes and submitted a PR

Kindly review it and provide your feedback. Thank you!

@tfsumon , does this include the redirection feature too?

[tfsumon]

yes.

[devopstoday11]

@tfsumon , Found a bug from this work - search on the home page is not working - https://docs.intelops.ai/

[tfsumon]

I've tested the main repo code locally, and it works well. Can you share more details about this issue? @devopstoday11

[devopstoday11]

I've tested the main repo code locally, and it works well. Can you share more details about this issue? @devopstoday11

@tfsumon , yes it is weird. When I tested in my local, that search didn't work. I just tested on the live docs site, it is working. I guess it is fine now.