CONTRIBUTING.md

Hi, Welcome to the contributing guide for the search.opensuse.org website. We are very eager to take any and all contributions from you, and to aid you in successfully contributing to this codebase.

• About
  • Where is the code hosted?
  • What are the technologies used?
  • Get in contact with us!
  • Submitting changes
• Reporting Bugs
  • Fixing Bugs
• Setting up the development environment
• How to update the data on the site
  • Search Engines

About

Where is the code hosted?

You can find the canonical git repository here: https://github.com/openSUSE/search-o-o.git

What are the technologies used?

This is a jekyll based website, using the openSUSE theme. It is extended with a few plugins in </_plugins/>, which allows for an extended usage of jekyll.

Get in contact with us!

We are available on various instant messaging platforms, as well as more traditional mailing list, use the links below to get in contact if you need or want to.

• Matrix: https://matrix.to/#/#web:opensuse.org
• Discord: https://discord.gg/openSUSE
• Mailing Lists: https://lists.opensuse.org/archives/list/[email protected]/

Submitting changes

To submit changes for review, create a pull request on the site's GitHub, if your PR contains UI changes, please include a screenshot before and after, so that it's easier for us to review the changes.

Reporting Bugs

Bugs in this repo need to be reported to the GitHub Issues on the GitHub repo. You can do so here: https://github.com/openSUSE/search-o-o/issues/new

Fixing Bugs

The link below lists all the currently reported bugs against the project on GitHub. https://github.com/openSUSE/search-o-o/issues Those bugs still need fixing and we would appreciate any pull requests fixing them.

Setting up the development environment

You will need to install git, ruby, gem and bundler first, then, to gather the remaining dependencies, run:

git clone https://github.com/openSUSE/search-o-o.git
cd search-o-o
bundle config set path 'vendor/bundle'
bundle install

To build the site, run

bundle exec jekyll build

To serve the site on your local machine, run:

bundle exec jekyll serve

and visit http://127.0.0.1:4000/ to see it in your browser

How to update the data on the site

Various parts of this site are stored as data used for generation of pages. This section of the guide explains how to update those.

Search Engines

Search Engines information is stored in _data/search-engines.yml.

- name: # Name of the engine
  key: # key name of the engine
  image: # image in /assets/search/
  url: # Search engine url

Thank you for considering contributing!