Giter Club home page Giter Club logo

website's Introduction

Website for Fedora Developer Portal

This repository contains Jekyll templates, HTML and CSS files for the Fedora Developer Portal.

If you are here to submit issue or PR regarding the content of the portal, please do so in the content repository: https://github.com/developer-portal/content.

Dynamic part of the site

There is an rss.rb script that replaces the blog posts section on the index page in generated _site/ from the Fedora Planet.

Tests

We have some basic Capybara/Webkit test specifications that can help you to notice if something broke. It will also check all internal links between pages that they actually work. To execute them, run:

$ rspec spec

Local development instance

Using Vagrant

To start developing clone the website and content repositories and run vagrant up. Afterwards just start the Jekyll server at 0.0.0.0 (instead of default loopback).

$ git clone https://github.com/developer-portal/website.git && cd website
$ git clone https://github.com/developer-portal/content.git
$ vagrant up
$ vagrant ssh
vagrant$ cd /vagrant
vagrant$ jekyll serve --force_polling -H 0.0.0.0

Once done, you can open http://127.0.0.1:4000/ on your host to see the generated site.

We use rsync by default so you need to run vagrant rsync-auto on your host to keep the sources synced.

If you don't have Vagrant installed, here is how to do it on Fedora: https://github.com/developer-portal/content/blob/master/tools/vagrant/vagrant-libvirt.md

Using a Docker container

Docker container provides a simple way how to run the development instance of Developer Portal. Following command will start the Jekyll server in a container (with very similar output):

$ sudo docker run -it --rm developerportal/devel
Configuration file: /website/_config.yml
            Source: /website
       Destination: /website/_site
      Generating...
                    done.
 Auto-regeneration: enabled for '/website'
Configuration file: /website/_config.yml
    Server address: http://172.17.1.16:8080/
  Server running... press ctrl-c to stop.

The above command will serve the latest content available in Github repository. If you want to do some changes in a website repository and view them, you need to add argument -v /path/to/your/repo:/opt/developerportal/website:

$ sudo docker run -it --rm -v $PWD:/opt/developerportal/website developerportal/devel

In case you want to modify the content repository, you need to add argument -v /path/to/content/repo:/opt/developerportal/website/content:

$ sudo docker run -it --rm -v $PWD/content:/opt/developerportal/website/content developerportal/devel

Using local installation

Before fetching the sources from GitHub make sure you have the public keys uploaded to your GitHub account. Here is how to do it: https://help.github.com/articles/error-permission-denied-publickey/.

Then run:

$ git clone [email protected]:developer-portal/website.git && cd website
$ git submodule init
$ git submodule update
$ jekyll serve --force_polling

jekyll serve --force_polling will start the development server at http://127.0.0.1:4000/ and regenerate any modified files for you. If you don't have Jekyll installed, here is the installation guide: http://jekyllrb.com/docs/installation/.

If you want to install Jekyll on Fedora, you can just run the ./setup.sh script included in this repository.

To update the content/ directory fetched by git submodule update just switch to that directory, make sure you are on the master branch and pull the latest stuff:

$ cd content
$ git checkout master
$ git pull

If you just want to download the sources without uploading your keys get the sources as:

$ git clone https://github.com/developer-portal/content.git

website's People

Contributors

asamalik avatar mairin avatar phracek avatar vpavlin avatar strzibny avatar msrb avatar stickster avatar

Watchers

Rick Elrod avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.