rtyler
/
jenkins.io
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update make target descriptions

This commit is contained in:
Liam Newman 2018-04-19 15:38:12 -07:00
parent 85a84610d9
commit 24676106b6
1 changed files with 27 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
CONTRIBUTING.adoc
View File

@ -39,6 +39,12 @@ When they are ready you will push your changes to your your fork and submit a pu
== Building
This project uses GNU/Make and Docker in order to generate the fully statically
generated link:https://jenkins.io[jenkins.io] web site. The key tool for
converting source code into the site is the
link:http://awestruct.org[Awestruct] static site generator,
which is downloaded automatically as part of the build process.
Ensure you have GNU/Make and Docker available on your machine:
* `make --version`
@ -46,24 +52,28 @@ Ensure you have GNU/Make and Docker available on your machine:
Docker must be version 17.04 or greater.
[[make-targets]]
=== `make` Targets
=== Instructions
Run `make` to run a full build, or `make <target>` using one of the targets below
to achieve specific results.
This project uses GNU/Make and Docker in order to generate the fully statically
generated link:https://jenkins.io[jenkins.io] web site. The key tool for
converting source code into the site is the
link:http://awestruct.org[Awestruct] static site generator.
==== Make Targets
* *make prepare* will download external dependencies and files necessary to
build the site. It is recommended that this be executed at least once before
authoring new content. This target is not a dependency of `run` or `generate`
as an optimization to make iterating on content locally more pleasant.
* *make run* will run a live-reloading development server on
link:http://localhost:4242/[localhost:4242]
* *make pdfs* will explicitly generate new PDFs
* *all* (default target) will run a full build of the site, including
`prepare`, `generate`, and `archive`. This will also download and regenerate external resources.
* *clean* will remove all build output and dependencies in preparation for a full rebuild.
* *prepare* will download external dependencies and resources necessary to
build the site. As an optimization to make iterating on content locally more pleasant,
dependencies and resources will not be downloaded again unless the `clean` target is called first.
The exeception being `all` will download and regenerate external resources
(but not download dependencies which are more bandwidth intensive).
* *generate* will run `site` and `pdfs`.
* *site* will explicitly generate static website files.
* *pdfs* will explicitly generate new PDFs
* *run* will run a live-reloading development server on
link:http://localhost:4242/[localhost:4242].
* *user-site* will publish the `jenkins.io` website to your own "GitHub Pages".
While useful for review purposes this has some known issues and limitations.
See <<user-site>> for details.
== Editing content
@ -480,7 +490,7 @@ would create the directory `content/my-clean-url` and if I were creating an
Asciidoc file, I would then create the file `content/my-clean-url/index.adoc`.
(Advanced Haml users would create `content/my-clean-url/index.html.haml`).
[[user-site]]
== Deploying jenkins.io on GitHub pages
There is rudimentary support for publishing the `jenkins.io` website to your own