This is the homepage served at www.webplatform.org. We are serving them as non dynamic content due to the fact that we do not need to change the content frequently.
Although this workspace is for the static content of the site, it can also be used to work locally on HTML and CSS markup and patterns for various projects inside WebPlatform Docs.
The pages are generated through a Node.js static site generator called DocPad and allows us to keep edition DRY by not copy-pasting code in many places while allowing us to have static documents to serve. To learn more about DocPad, you can refer to their DocPad documentation.
NOTE: Directives assumes you are using a Unix like Operating System, but DocPad also works with Microsoft Windows.
-
Install NodeJS and NPM
You can download node from nodejs.org.
As for NPM, it depends of the Operating system you are using. You can see the NPM installation instruction from the nodejs website.
-
Fork the project, and checkout the code
mkdir -p ~/workspace/webplatform/www cd ~/workspace/webplatform/www git clone [email protected]:renoirb/www.webplatform.org.git . make dev-depsThis installs all dependencies to work on the project.
-
Create a branch and start your work.
git checkout -b improving-flexbox-markup -
Code is managed from the
src/folder, and what gets changed in it gets regenerated automatically by what we call a "watcher", files are regenerated at every changes intoout/folder.make dev-localYou can also leverage work with CSS and JavaScript using built in tools:
-
JavaScript Linting
make lint -
Work on assets with live reload
make dev-local -
Work on SASS files, open up another tab (leave
make dev-localrun)make dev-compass
NOTE: Working on CSS, have a look at README.contributing-css.md.
IMPORTANT: Compass is taking care to compile SASS files from
sass/. It is configured to write tosrc/documents/assets/css/. You can configure Compass to watch files for you and copy them in thesrc/folder. Technically DocPad should detect changes insrc/documents/and refresh the equivalent files inout/. Which is not always the case. This will be fixed with issue Fixing DocPad and Compass compilation conflictsmake generate-
Testing before pushing to the repository
make static
This gives you an equivalent of what gets deployed in production without watchers. It’ll create a local web server to test things out. If you have access to the salt master, you can follow the procedure described in Accessing a VM using SSH and try the website through the proxy it describes. Look at the port number
make staticgives in the Makefile, use your web browser that you configured the proxy to the addresshttp://salt:9778/.- Everything works? Make a pull request from your branch :D
-
-
Prepare for deploying
make deps make generateIf you are on the salt master, this can be run from
/srv/code/www/repo, then you can use Salt to deploywpd-deploy appIf you are happy and want to make a dated snapshot of it;
make package -
... In progress...
Current plan is that when a person who has rights to merge to master, a deployment system will pull from github, run the scripts in the previous step, sync the files with all web servers. Automatically.
For more details, see package.json file.
- Gulp, JavaScript build system
- DocPad, static pages generation
- DocPad plugin "eco", templating
- DocPad plugin "frontend", managing assets
- DocPad plugin "livereload", workspace live reload
- DocPad plugin "marked", MarkDown support
- DocPad plugin "nodesass", NodeJS SASS support
- DocPad plugin "partials", view partials
Besides reading the source, I found those pages useful.