Added compage as git submodule

[tfsumon]

No description provided.

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[devopstoday11]

@tfsumon ,
when I got your repo's " tfsumon:chandu " branch to test it in my local first, it did not work.
all I did is run " hugo server " and I was not able to see the compage docs. Submodule Folder content/compage was showing empty.

After googling, I tried few commands and one worked for me :

git submodule add -b chandu -f --name compage https://github.com/intelops/compage-docs/ content/compage

When I ran this command it added below content into .gitmodules file :

[submodule "compage"]
	path = content/compage
	url = https://github.com/intelops/compage-docs/
	branch = chandu

Why this below didn't work originally?

[submodule "content/compage"]
	path = content/compage
	url = https://github.com/intelops/compage-docs/
	branch = chandu
	ignore = dirty

Do I need to do something after cloning your repo to my local to make it work? What steps to follow?

[tfsumon]

Working with Existing Submodules

1. Start by cloning the main repository using:
   git clone [main_repo_url]

2. Update the existing submodule to synchronize with the remote submodule repository by executing::
   git submodule update --init --recursive --remote

3. Alternatively, clone the repository along with all its submodule files and folders using the command:
   git clone --recursive [main_repo_url]

4. After running the command, your local submodule folder will be updated with the latest files and folders from the remote submodule repository.

To add new submodule follow this prodcecure

1. Here's an example to make it easier to understand. Suppose you want to add the content/kubviz folder as a git submodule. First, create a repository containing the contents of the kubviz folder (without adding external files like .gitignore or readme). Then, add this newly created repository as a git submodule in your main repository using the following command:
   git submodule add https://github.com/tfsumon/kubviz.git ./content/kubviz
   In this command, ./content/kubviz represents the folder where you want to place the submodule folder.

Reference:
Git Tools - Submodules

[dryrunsecurity]

Hi there 👋, @DryRunSecurity here, below is a summary of our analysis and findings.

DryRun Security	Status	Findings
AppSec Analyzer (beta)	✅	0 findings
Secrets Analyzer	✅	0 findings
Authn/Authz Analyzer	✅	0 findings
Configured Codepaths Analyzer	✅	0 findings
Sensitive Files Analyzer	✅	0 findings

Note

🟢 Risk threshold not exceeded.

Tip

Get answers to your security questions. Add a comment in this PR starting with @DryRunSecurity. For example...

@dryrunsecurity What are common security issues with web application cookies?

Powered by DryRun Security

[dryrunsecurity]

DryRun Security Summary

The pull request primarily involves updates to Markdown files and the addition of a new Git submodule, which requires careful review to ensure the security of the submodule integration and the absence of any immediate security concerns.

Expand for full summary

Summary:

The changes in this pull request primarily involve updates to various Markdown files and the addition of a new Git submodule. From an application security perspective, the changes do not appear to introduce any immediate security concerns.

The updates to the Markdown files, such as setting the draft status and modifying metadata, are routine and do not directly impact the application's security posture. However, it's important to continue monitoring the contents of these files to ensure that no sensitive information or potential security vulnerabilities are introduced in the future.

The addition of a new Git submodule is the most significant change from a security perspective. While submodules can be a useful feature, they can also introduce potential security risks if the submodule repository is compromised or contains malicious code. It's crucial to carefully review the submodule repository, the specific branch used, and the ignore = dirty setting to ensure that the integration does not introduce any security vulnerabilities.

Files Changed:

1. content/capten/_index.md:

   • Added type: "docs-root" and draft: true lines to the file's metadata.
   • Changes are related to the structure and status of the documentation, with no direct impact on application security.

2. content/changelog.md:

   • Updated the date field in the front matter.
   • Removed the layout field from the front matter.
   • Changes are related to the file's metadata and do not introduce any security concerns.

3. content/capten/changelog/_index.en.md:

   • Changed the draft property from false to true.
   • This change marks the current version of the changelog as a draft, which is a common practice and does not raise any security concerns.

4. .gitmodules:

   • Added a new Git submodule at the path content/compage, pointing to the repository https://github.com/intelops/compage-docs/ and the chandu branch.
   • The ignore = dirty setting was also added, which can potentially mask changes made to the submodule.
   • This change requires careful review to ensure the security of the submodule integration, as it could introduce potential security risks if not properly managed.

Code Analysis

We ran 9 analyzers against 30 files and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

[devopstoday11]

@tfsumon I still didn't get response about follow up questions on this feature. I asked you discord too.
I need guidance on how to use this feature (guidance once again)

[tfsumon]

@tfsumon I still didn't get response about follow up questions on this feature. I asked you discord too. I need guidance on how to use this feature (guidance once again)

@devopstoday11

I'd be happy to help clarify the guidance you're having trouble with. Could you tell me specifically what part of the instructions in the following link is unclear?

#89 (comment)

Thank you!