d-enow / fedora-websites

Forked from fedora-websites 2 years ago
Clone
README.md

NOTE

The getfedora.org sources now live in a new repository and are built with Flask and Frozen-Flask. The other sites remain in this current repository that you are looking at right now.


This is the Fedora Websites GIT repo used to build the websites starting from the F24 release cycle.

History of previous commits is still available in the old repo on Fedora Hosted. For more information please read the documentation and the Fedora Websites pages on the Fedora Wiki


Contributing

If you like to help the websites team but are not actually a member, you can easily file Pull Requests. Fork this repository, make your changes and submit them here. Check of the Fedora Websites wiki for details on how to become a member of the websites team.

Translations are handled by the Fedora localization team on Fedora Weblate.

Translation status


Websites

This repository contains the sources for the following Fedora Websites:


Getting started

You can either run the project on your local environment following the manual installation procedure, or you can do a 'one-touch' installation using containers (Podman). For non-Fedora users, running the project using podman is recommended.


1. Manual Installation

WARNING: DO NOT execute the following steps as root, just use your normal user:

VERIFY: You should have python 2.7 installed and enabled. The below command should give you the output "Python 2.7.x"

python --version

1. Setup your system

sudo dnf install git gettext python2-genshi python-lxml python-setuptools python-dateutil \
python-dogpile-cache babel python-feedparser fedfind python-requests python2-babel

sudo dnf groups install 'Web Server'

2. Clone the fedora-websites repo

git clone https://pagure.io/fedora-websites.git

3. Enter the directory of the website you want to work on

For example, if you want to work on spins.fedoraproject.org, use:

cd fedora-websites/spins.fedoraproject.org

4. Launch a test instance

make en test

5. Stop the test instance

make stoptest

Note: if you have caching problems you can clean the instance even more:

make veryclean


2. Installation using Podman

1. Fork and Clone the fedora-websites repo

For example, if your username is "john-doe", use:

git clone https://pagure.io/forks/john-doe/fedora-websites.git

2. Build the image

podman build -t fedora-web .

3. Run the image in interactive mode

podman run -it -p 5000:5000 fedora-web

4. Enter the directory of the website you want to work on

For example, if you want to work on spins.fedoraproject.org, use:

cd spins.fedoraproject.org

5. Launch a test instance

make en test

6. Stop the test instance

make stoptest


Submitting a pull request

1. Create an ssh key

ssh key-gen

2. Fork and Clone the repository

For example, if your username is "john-doe", use:

git clone ssh://git@pagure.io/forks/john-doe/fedora-websites.git

3. Set the origin remote repository

git remote set-url origin ssh://git@pagure.io/requests/john-doe/fedora-websites.git

4. Create a branch

git checkout -b feature

5. Commit and Push changes

git commit -m "made x changes to file y"
git push origin feature

6. Open a pull request

See details here on how to open a pull request.