1. Project Overview & Quickstart (amundsen-io/common)
1. Project Overview & Quickstart (amundsen-io/common)
1. Project Overview & Quickstart (amundsen-io/common)
common
Doctrine Common
Repository Details
- Repository: amundsen-io/common
- GitHub Stars: ⭐ 5,812
- Primary Language: PHP
Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.
2. Official Technical Reference & Guides (amundsen-io/amundsen-io.github.io)
Amundsen Marketing Site
Built using NPM, Jekyll, and Tailwind.css via npm start.
Repo structure and branches
We use GitHub pages to deploy amundsen.io. We use GitHub organization pages (instead of project pages). There are two ways to deploy GitHub pages:
- You push the source (HTML, CSS, JS, etc.) to
masterbranch and have GitHub build and deploy using Jekyll. - You push the distribution (usually a folder called
distfrom local build) tomasterbranch. GitHub simply deploys the pre-built distribution then.
We only support option #2 for this repository. This means that master branch contains the code for generating the distribution. It also contains the locally built distribution in the docs folder (NOT dist). Note, as of now, you can only use master branch to put content of GitHub pages for an organization.
Making changes
In order to make changes, you'd have to make changes locally, build using Jekyll, test changes locally and then push both the code and the distribution (in the docs folder) to the master branch. Use can follow these instructions to do local set up. In order to build, use gulp and to serve locally, use gulp serve.
2. Official Technical Reference & Guides (amundsen-io/amundsen-io.github.io)
Amundsen Marketing Site
Built using NPM, Jekyll, and Tailwind.css via npm start.
Repo structure and branches
We use GitHub pages to deploy amundsen.io. We use GitHub organization pages (instead of project pages). There are two ways to deploy GitHub pages:
- You push the source (HTML, CSS, JS, etc.) to
masterbranch and have GitHub build and deploy using Jekyll. - You push the distribution (usually a folder called
distfrom local build) tomasterbranch. GitHub simply deploys the pre-built distribution then.
We only support option #2 for this repository. This means that master branch contains the code for generating the distribution. It also contains the locally built distribution in the docs folder (NOT dist). Note, as of now, you can only use master branch to put content of GitHub pages for an organization.
Making changes
In order to make changes, you'd have to make changes locally, build using Jekyll, test changes locally and then push both the code and the distribution (in the docs folder) to the master branch. Use can follow these instructions to do local set up. In order to build, use gulp and to serve locally, use gulp serve.
2. Official Technical Reference & Guides (amundsen-io/amundsen-io.github.io)
Due to inactivity, this project was archived in September 2026. The contents will remain available for historical purposes.
Amundsen Marketing Site
Built using NPM, Jekyll, and Tailwind.css via npm start.
Repo structure and branches
We use GitHub pages to deploy amundsen.io. We use GitHub organization pages (instead of project pages). There are two ways to deploy GitHub pages:
- You push the source (HTML, CSS, JS, etc.) to
masterbranch and have GitHub build and deploy using Jekyll. - You push the distribution (usually a folder called
distfrom local build) tomasterbranch. GitHub simply deploys the pre-built distribution then.
We only support option #2 for this repository. This means that master branch contains the code for generating the distribution. It also contains the locally built distribution in the docs folder (NOT dist). Note, as of now, you can only use master branch to put content of GitHub pages for an organization.
Making changes
In order to make changes, you'd have to make changes locally, build using Jekyll, test changes locally and then push both the code and the distribution (in the docs folder) to the master branch. Use can follow these instructions to do local set up. In order to build, use gulp and to serve locally, use gulp serve.