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

Discussion #4

Open
tfsojon opened this issue Oct 9, 2022 · 27 comments
Open

Discussion #4

tfsojon opened this issue Oct 9, 2022 · 27 comments

Comments

@tfsojon
Copy link
Collaborator

tfsojon commented Oct 9, 2022

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

@devopstoday11
Copy link
Contributor

@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
Copy link
Collaborator Author

tfsojon commented Oct 12, 2022

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

@devopstoday11
Copy link
Contributor

@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
Copy link
Collaborator Author

tfsojon commented Oct 13, 2022

@devopstoday11

  • dynamic copyright updated
  • doc collapse
  • TOC
  • full width doc layout
  • improved typography
  • language support
  • responsive menu and sidebar fix
  • fixed search result

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

@devopstoday11
Copy link
Contributor

@tfsojon
What does TOC mean?

@tfsojon
Copy link
Collaborator Author

tfsojon commented Oct 20, 2022

Table of Content

@devopstoday11
Copy link
Contributor

@tfsojon
The documentation versioning is still missing.

@devopstoday11
Copy link
Contributor

@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
Copy link
Collaborator Author

tfsojon commented Oct 20, 2022

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
Copy link
Collaborator Author

tfsojon commented Oct 22, 2022

fix search result issue and added random features and fixes

@devopstoday11
Copy link
Contributor

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

@devopstoday11
Copy link
Contributor

@tfsojon
Copy link
Collaborator Author

tfsojon commented Apr 1, 2023

@devopstoday11 Are you available now?

@devopstoday11
Copy link
Contributor

@tfsojon
What's up?

@tfsojon
Copy link
Collaborator Author

tfsojon commented Apr 1, 2023

image

@tfsojon
Copy link
Collaborator Author

tfsojon commented Apr 1, 2023

check the new PR #20

@tfsojon
Copy link
Collaborator Author

tfsojon commented Apr 1, 2023

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

@devopstoday11
Copy link
Contributor

image

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

@devopstoday11
Copy link
Contributor

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
Copy link
Collaborator Author

tfsojon commented Apr 1, 2023

Not same. Please check the PR.

@tfsojon
Copy link
Collaborator Author

tfsojon commented Apr 1, 2023

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
Copy link
Contributor

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
Copy link
Collaborator Author

tfsojon commented Apr 1, 2023

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
Copy link
Contributor

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
Copy link
Contributor

@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
Copy link
Collaborator Author

tfsojon commented Apr 1, 2023

ok send me the link please

@devopstoday11
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants