| |
@@ -11,7 +11,9 @@
|
| |
|
| |
History of previous commits is still available in the [old repo on Fedora Hosted](https://git.fedorahosted.org/cgit/fedora-web.git/). **For more information please read the [documentation](https://docs.pagure.org/fedora-websites/) and the [Fedora Websites pages on the Fedora Wiki](https://fedoraproject.org/wiki/Websites)**
|
| |
|
| |
- ### Contributing
|
| |
+ <br />
|
| |
+
|
| |
+ ## 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](https://fedoraproject.org/wiki/Websites#Join_the_Websites_Team) for details on how to
|
| |
@@ -21,8 +23,9 @@
|
| |
|
| |
[](https://translate.stg.fedoraproject.org/engage/abrt/?utm_source=widget)
|
| |
|
| |
+ <br />
|
| |
|
| |
- ### Websites
|
| |
+ ## Websites
|
| |
This repository contains the sources for the following Fedora Websites:
|
| |
|
| |
* http://alt.fedoraproject.org
|
| |
@@ -42,10 +45,21 @@
|
| |
* http://start.fedoraproject.org
|
| |
* http://iot.fedoraproject.org
|
| |
|
| |
- ### Getting started
|
| |
+ <br />
|
| |
+
|
| |
+ ## 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.
|
| |
+
|
| |
+ <br />
|
| |
+
|
| |
+ ### **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 \
|
| |
@@ -58,9 +72,9 @@
|
| |
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 getfedora.org, use:
|
| |
+ For example, if you want to work on spins.fedoraproject.org, use:
|
| |
|
| |
- cd fedora-websites/getfedora.org
|
| |
+ cd fedora-websites/spins.fedoraproject.org
|
| |
|
| |
#### 4. Launch a test instance
|
| |
|
| |
@@ -73,3 +87,64 @@
|
| |
**Note:** if you have caching problems you can clean the instance even more:
|
| |
|
| |
make veryclean
|
| |
+
|
| |
+ <br />
|
| |
+
|
| |
+ ### **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
|
| |
+
|
| |
+ <br />
|
| |
+
|
| |
+ ## 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](https://docs.pagure.org/pagure/usage/pull_requests.html#:~:text=Pagure%20to%20Pagure%20pull%20request&text=Locate%20your%20feature%20branch%20(Right,and%20create%20your%20pull%20request.)) on how to open a pull request.
|
| |
+
|
| |
\ No newline at end of file
|
| |
d-enow
commented 2 years ago
Closes #1117