This is the Doctrine Sculpin website code.

First clone the source code for the website to a directory like /data:

cd /data
git clone [email protected]:doctrine/doctrine-website-sculpin.git
composer install

Next clone the repository which holds the built source code to /data/doctrine-website-sculpin-build-prod:

git clone [email protected]:doctrine/doctrine-website-sculpin-build.git /data/doctrine-website-sculpin-build-prod

Create a development directory for you to create dev builds in /data/doctrine-website-sculpin-build-dev for testing:

mkdir /data/doctrine-website-sculpin-build-dev

This command accepts an argument for where the Doctrine repositories with the documentation will be cloned:

./vendor/bin/sculpin doctrine:prepare-docs /data/doctrine

Now you are ready to build the website for the first time:

./vendor/bin/sculpin doctrine:build-website /data/doctrine-website-sculpin-build-dev --env=dev

Setup lcl.doctrine-project.org locally and point your webserver at /data/doctrine-website-sculpin-build-dev to see the website:

You can watch for changes in the source code and automatically build the website:

./vendor/bin/sculpin doctrine:watch /data/doctrine-website-sculpin-build-dev

The browser will automatically refresh after the build finishes.

Now to make a production build:

./vendor/bin/sculpin doctrine:build-website /data/doctrine-website-sculpin-build-prod --env=prod

To publish the new version pass the --publish option:

./vendor/bin/sculpin doctrine:build-website /data/doctrine-website-sculpin-build-prod --env=prod --publish

Assuming you put all your data in the /data path you can use these shortcuts for building and publishing:

./build dev
./build prod
./build staging

The prod environment publishes to new.doctrine-project.org and the staging environment publishes to staging.doctrine-project.org. You can only publish the prod and staging environments.

./publish prod
./publish staging

Watch for changes:

./watch

• Integrate API docs with new website.
• Setup some kind of automated git push -> deploy process. Can this be done with travis-ci?
• Get algolia upgraded and change indexing to use proper structured data from the meta.php files that the rst builder outputs. I think we can remove SculpinAlgoliaSearchBundle and do something simpler and more straight forward to populate the indexes in Algolia.
• Build UX for switching between versions
• Enhance the /projects/{project} path in to a combined page that lists install, github link and documentation in one? Goal, reduce clicks from initial entry.
• Turn on HSTS?
• Add Doctrine team page. Example: https://nette.org/contributors
• Rewrite /contribute, /about and /community pages
• Run a link checker to look for 404s

• Can we do the code highlighting server side on build instead of in the browser with highlightjs?