search

intelops / external-docs

This is the repo to manage all the public documentation.
https://docs.intelops.ai
1 stars 10 forks source link

Discussion #4

Open tfsojon opened 2 years ago

tfsojon commented 2 years ago

@chandu-intelops @devopstoday11 Please commit and push the changes you have made otherwise my changes will conflict with yours.

devopstoday11 commented 2 years ago

@tfsojon - I am not touching anything in this repo. please proceed and push your changes. The changes which you have seen in the video I provided were the ones I am playing with and it is a copy for my internal purpose. Please push your changes, I am waiting on you.

tfsojon commented 2 years ago

@devopstoday11, Not able to push code. Please add @tfsojon as a maintainer in this repo.

devopstoday11 commented 2 years ago

@tfsojon Last time you submitted PR. Please follow same process. It's a public repo. When you fork it and do the work, you can submit PR.

tfsojon commented 2 years ago

@devopstoday11

(please check search and let me know it's properly working or not)

devopstoday11 commented 2 years ago

@tfsojon What does TOC mean?

tfsojon commented 2 years ago

Table of Content

devopstoday11 commented 2 years ago

@tfsojon The documentation versioning is still missing.

devopstoday11 commented 2 years ago

@tfsojon , Different topic..... If I ever want to hide any page or any block or row or a particular section in a page from main site , how to hide them, where do I declare that hide & show parameters? I don't want to depend on Forestry. The less we depend on Forestry, the better. Please make a video a show how to achieve the above scenario.

tfsojon commented 2 years ago

Implemented doc version system

Currently search only works on latest doc version. Please check and let me know if it's need any improvements?

also check this options in config.toml file

image

tfsojon commented 2 years ago

fix search result issue and added random features and fixes

devopstoday11 commented 2 years ago

@tfsojon you made the search work for the latest and also old versions, right?

devopstoday11 commented 2 years ago

@tfsojon , new feedback/issues - https://www.loom.com/share/d87e953b601c44beabda25b8370a9de5

tfsojon commented 1 year ago

@devopstoday11 Are you available now?

devopstoday11 commented 1 year ago

@tfsojon What's up?

tfsojon commented 1 year ago

image

tfsojon commented 1 year ago

check the new PR https://github.com/intelops/external-docs/pull/20

tfsojon commented 1 year ago

and the 404 error showing because the main branch and chandu branch's content is not same.

devopstoday11 commented 1 year ago

image

I was not able to understand how to use that structure. Please explain in a video @tfsojon

devopstoday11 commented 1 year ago

and the 404 error showing because the main branch and chandu branch's content is not same.

I thought it is same. Let me check again and get back to you @tfsojon

tfsojon commented 1 year ago

Not same. Please check the PR.

tfsojon commented 1 year ago

I was not able to understand how to use that structure. Please explain in a video @tfsojon

What will be the content structure of your changelog? that's what I asked for.

devopstoday11 commented 1 year ago

and the 404 error showing because the main branch and chandu branch's content is not same.

I thought it is same. Let me check again and get back to you @tfsojon

404 error which I mentioned in the video regarding "edit in git repo" button is for chandu branch only. I didn't push to main branch yet. So, the issue is still there in chandu branch. after you fix it, then I will merge to main branch. @tfsojon

tfsojon commented 1 year ago

we have to set the git url here in config.toml file. currently the url branch is main - image

also did you checked the new PR? specially the changelog content folder? What will be the content structure of your changelog? Is this correct? - https://github.com/tfsojon/external-docs/tree/main/content/1.0.0/changelog

devopstoday11 commented 1 year ago

and the 404 error showing because the main branch and chandu branch's content is not same.

I thought it is same. Let me check again and get back to you @tfsojon

404 error which I mentioned in the video regarding "edit in git repo" button is for chandu branch only. I didn't push to main branch yet. So, the issue is still there in chandu branch. after you fix it, then I will merge to main branch. @tfsojon

@tfsojon one more thing which I explained in video was, when I click on "edit in git repo" button, no need to open the exact file in the github. Just make it open the folder or just the git repo. That's enough.

For example, when I click on edit button when I am inside documentation of a topic, then it should open https://github.com/intelops/external-docs/tree/main/content/1.0.0/compage If I am inside change log and I click edit button it should take me to the changelog folder - https://github.com/intelops/external-docs/tree/main/content/1.0.0/changelog

So the syntax would be like this - image

Hope you got what needs to be opened when the edit button is clicked? @tfsojon

devopstoday11 commented 1 year ago

@tfsojon can you join a quick call to discuss on changelog usage. I think the folder structure you gave for changelog is fine but I am not able to understand how to use it. I can share google meet link and we can discuss quickly for 5 minutes

tfsojon commented 1 year ago

ok send me the link please

devopstoday11 commented 1 year ago

Thanks for the quick call, @tfsojon. Please proceed with the items discussed.