cycleplatform / docs-portal Goto Github PK

Create initial README.md

• Need to update Algolia key and index
• Implement force re-crawl on deploy to prod

Add information describing the correct format for sub-module repo urls and errors.

The top level repo needs to be without the ssh:/// platform will auto remove it, but all sub repos need to be with the ssh:// format for the urls.

If the error states unable to pull repo: parse "<user>@<example.com>:repo/path.git": first path segment in URL cannot contain colon it is pretty much guaranteed it is due to a sub repo url being incorrect, unless the image is very very old