terrorizer1980 / 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.

As soon as your changes get merged in obs-docu (see how here), you have to move to obs-landing repository and follow these steps to deploy them:

• Make sure obs-landing's master branch is up-to-date.
• Run the update_documentation.sh script placed in the root directory which will:
  • update the documentation sub-module;
  • generate the documentation in html, pdf and epub formats;
  • create a commit with the message "Update books to current state".
• Push to master the newly created commit.

Then, you'll see your changes in https://openbuildservice.org/help.

OBS Documentation Troubleshooting

Untracked Changes

If, after following the steps, your working tree is not clean and shows some untracked changes related to open-build-service-documentation, simply run git submodule init and git submodule update manually.

Validation Errors When Running the Script

When running the script, you might get validation errors that you didn't get when you ran daps independently. This usually happens when the document contains references to online resources like this:

  <imagedata fileref="https://example.com/my-image.png"/>

Better add the resource to the corresponding directory inside images/src/. This is an example of how to reference it:

  <imagedata fileref="my-image.png"/>

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.