davidkang / obs-landing

The Open Build Service project landing page

The Open Build Service Landing page

This page is based on Jekyll and Foundation and is served via Netlify to openbuildservice.org

Markdown

Pages are written in kramdown. A quick reference for the syntax can be found here.

Local Preview

Run docker-compose up and access http://localhost:4000

Deployments

Deployments are automated with a webhook, so whenever commits are pushed to master, a new version will be published. The deployments are listed here.

Add New Members to Team Page

Add the following lines at the end of the YAML front matter block:

- name: Example Name
  position: Frontend Developer
  email: [email protected]
  github: examplegithub
  twitter: exampletwitter
  blog: https://examplename.com
  irc: exampleirc
  description: "Write a nice description of yourself.
  You can use **markdown** in ~~the~~ _description_.

  \nAnd add new paragraphs too."

You don't need to include all the fields, you can just remove the one you don't want to have. If you use special characters you may need to surround your text by ".

Updating OBS Documentation

The OBS documentation is stored in a separate repository and is integrated into the OBS landing page via git submodules.

After doing some changes in obs-docu (see how here) you should wait until they are merged and then move to your local directory of obs-landing. Update it and run the update_documentation.sh script that you can find inside the obs-landing project. This updates the documentation sub-module, compiles it into html and creates a new commit with the changes. The new commit's message is "Update books to current state".

Make sure that your working tree is clean. If it, on the contrary, shows some untracked changes in open-build-service-documentation, simply run git submodule init and git submodule update manually. This will update the submodule and will clean the working tree.

Once the last "Update books to current state" commit in obs-landing gets merged, you'll see your changes in https://openbuildservice.org/help.

License

The code in this repository is licensed under a MIT license.

The blog's content is licensed under a Creative Commons Attribution 4.0 International License.