muratkars / jx-docs

the source code used to build the documentation and website for Jenkins X

Jenkins X Docs

Documentation site for Jenkins X

Please browse these docs on the http://jenkins-x.io/ site as the links don't all work when browsing the markdown files inside github

Build the docs locally

To edit the docs locally and try out what the website will look like then you need to clone this repository:

$ git clone https://github.com/jenkins-x/jx-docs.git

Dockerized Hugo

Instead of installing Hugo locally, you can use the included local.Dockerfile to spin up the Hugo server. Make sure you have Docker installed.

• Build the image (only needed once): docker build -t jx-docs/dev -f local.Dockerfile .
• Run the server: docker run -v $PWD:/src -p 1313:1313 jx-docs/dev server -D --bind 0.0.0.0
• go to http://localhost:1313 to view the site

Local Hugo install

Then to view the docs in your browser, install Hugo. Navigate to the directory, run hugo server, and open up the link:

$ cd jx-docs
$ hugo server

Started building sites ...
.
.
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Contribution

Please visit the contributing guide for the documentation available at Jenkins X website.

Localization

In order to let more people know Jenkins X better, localization is very important and meaningful. And we should keep some rules about this, please read related languages below:

• Chinese