add content related folders & changelog folders as git submodules

[devopstoday11]

@tfsumon ,
After finishing the versioning change task, I need this to be done. Or, if it is quick steps to add in config.toml, let me know what to do, I will do it myself.

Assuming you finished the versioning task...
This is what I am planning to do to handle the Topics' related folders from outside the docs repo.

I want to create separate git repos for documentation purposes for the Topics "compage , capten , kubviz , genval". In those independent repos, we will write & submit all the documentation.
Now, in our main docs repo (external-docs) , I want to add those independent repos as git submodules.

separate repos -

https://github.com/intelops/compage-docs
https://github.com/intelops/capten-docs
https://github.com/intelops/kubviz-docs
https://github.com/intelops/genval-docs
https://github.com/intelops/compage-changelog
https://github.com/intelops/capten-changelog
https://github.com/intelops/kubviz-changelog
https://github.com/intelops/genval-changelog

After adding them as git submodules to the main docs repo "external-docs" , the folder names should still be same as original names in this main repo. No need to change names. This means we don't want to change anything in this main docs repo.

content/compage
content/capten
content/kubviz
content/genval
content/changelog/capten
content/changelog/compage
content/changelog/kubviz
content/changelog/genval

Please let me know if you understand the requirements or have any questions. @tfsumon

[tfsumon]

This task may require some time and I will handle it.

To begin, please create all topics and changelog repositories based on the current file structure, as illustrated below. Once done, kindly notify me:

changelog >
compage >
version_number

compage >
version_number

[devopstoday11]

Ok. We can work on this later. I will try one idea I have first and then I'll let you know when to start working on this one. @tfsumon
Thanks for prompt response

[devopstoday11]

This task may require some time and I will handle it.

To begin, please create all topics and changelog repositories based on the current file structure, as illustrated below. Once done, kindly notify me:

changelog > compage > version_number

compage > version_number

@tfsumon , I created separate repos like this

https://github.com/intelops/compage-docs/
https://github.com/intelops/compage-changelog/

I created like that for all the topics.

https://github.com/orgs/intelops/repositories?q=docs&type=all&language=&sort=
In this search page, you will find newly created repos I created with the topicname-docs and topicname-changelog as repo names. All those repos are empty for now.

[tfsumon]

All those repos are empty for now.

Kindly add data on those repo so that I can incorporate them as submodules. Submodules won't serve their purpose without any data.

@devopstoday11

[devopstoday11]

All those repos are empty for now.

Kindly add data on those repo so that I can incorporate them as submodules. Submodules won't serve their purpose without any data.

@devopstoday11

What should be the folders in those repos? @tfsumon
Give me some examples please.

[tfsumon]

Take a look at the following repository. I've added 'compage' 'capten' changelog & docs as submodules. Let me know if you'd like something similar or if you have other preferences.

https://github.com/tfsumon/sub-external-docs

@devopstoday11

Clone the repository with the following command to include all its submodule files and folders:

git clone --recursive https://github.com/tfsumon/sub-external-docs.git

[devopstoday11]

Take a look at the following repository. I've added 'compage' 'capten' changelog & docs as submodules. Let me know if you'd like something similar or if you have other preferences.

https://github.com/tfsumon/sub-external-docs

@devopstoday11

Clone the repository with the following command to include all its submodule files and folders:

git clone --recursive https://github.com/tfsumon/sub-external-docs.git

Yeah I got the idea now.

One more idea I would like to discuss with you :

can I keep both docs and changelog of a topic in same repo (new separate repo) and still be able to add it as submodules to the correct paths we want into the main docs site repo? @tfsumon

[tfsumon]

It's not possible to achieve that. Currently, all changelogs in the main repository are situated inside the 'changelog' folder, and topics are within the 'content' folder. Git submodules do not provide an option to include a specific repository folder in a particular location.

But it is possible if you organize all topic changelogs inside the 'content' folder instead of the 'changelog' folder.

@devopstoday11

[devopstoday11]

But it is possible if you organize all topic changelogs inside the 'content' folder instead of the 'changelog' folder.

could you please show me what you meant exactly? I didn't get it.
give me example folder structure in this message how to organize the folders. That will be easy to understand. @tfsumon

[devopstoday11]

@tfsumon

one more idea to discuss,

In the separate repos if I do this -
In compage-docs repo
compage/version-number
changelog/version-number

can we get those into the main docs site repo as submodules into the content/compage?
content/compage/version-number
content/compage/changelog/version-number
OR
content/compage/version-number/docs
content/compage/version-number/changelog

Based on this we can modify those other separated repo (compage-docs repo) structure.

And in the live docs site, the user interactions should still be same, no change in UI interaction.
@tfsumon

[tfsumon]

But it is possible if you organize all topic changelogs inside the 'content' folder instead of the 'changelog' folder.

could you please show me what you meant exactly? I didn't get it. give me example folder structure in this message how to organize the folders. That will be easy to understand. @tfsumon

Current folder structure:

1. content/compage
2. content/changelog/compage

If you reorganize the topics into the following structure, you can consolidate changelog and docs for topic into the same repository:

1. content/compage
2. content/compage-changelog

@devopstoday11

[devopstoday11]

If you reorganize the topics into the following structure, you can consolidate changelog and docs for topic into the same repository:

1. content/compage
2. content/compage-changelog

So the new structure in the main docs site repo will be like this ?

content/compage/version-number
content/compage-changelog/version-number

@tfsumon

[tfsumon]

Exactly. Tell me if you're okay with this.