feat: Set fork of theme repo as submodule and clone it shallow by def…

f-hollow commented 3 months ago

Currently, this repo has the original theme project nunocoracao / blowfish set as a submodule. This PR offers to set a fork (!move this fork under espressif/blowfish!) of the original theme project as a submodule due to the following benefits:

A fork allows us to have a branch (espressif-developer-portal) where we can make our own updates to the theme (I already deleted multimedia files there that we are definitely not going to use) and where we can pull changes from upstream/main in a controlled way.
Having our own branch also allows us to set it as the default submodule branch which we can clone in a shallow manner if we add shallow = true to .gitmodules.

As a result, running the basic command git clone --recursive https://github.com/espressif/developer-portal.git results in a clone of only 104 MB done in under one minute (as opposed to the current 500 MB in 2-3 minutes).

f-hollow commented 3 months ago

After cloning the repo, the submodule's active branch will still appear as HEAD detached at`. The submodules in other well-established and well-maintained projects also exhibit the same behavior, so I came to believe there is nothing out of the ordinary here.

f-hollow commented 3 months ago

@pedrominatel Can you please import the repo ⁠f-hollow/blowfish under espressif/blowfish?

f-hollow commented 3 months ago

@pedrominatel Can you please import the repo ⁠f-hollow/blowfish under espressif/blowfish?

Did it.

espressif / developer-portal

feat: Set fork of theme repo as submodule and clone it shallow by def… #24