https://github.com/hroncok/fedora-stewardship.github.io

https://github.com/hroncok/fedora-stewardship.github.io

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/hroncok/fedora-stewardship.github.io
• Owner: hroncok
• License: unlicense
• Created: 2020-03-25T18:06:59.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-25T18:26:11.000Z (almost 5 years ago)
• Last Synced: 2024-12-13T20:48:49.411Z (about 1 month ago)
• Homepage: https://fedora-stewardship.github.io
• Size: 18.3 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# fedora Stewardship SIG

Data and code in this git repository is either released into the Public Domain,

or licensed under the terms of the **Unlicense** license text contained in the

`LICENSE` file, whichever is applicable wherever you are.

For more information, read the files in `_pages`, or view the rendered docs at

.

### Rendering and viewing pages locally

To build and view documentation locally, install `ruby` and `bundler`, and then

execute `bundle install` or `bundle update`, which will download and build all

dependencies into the `vendor` folder. Once that's done, you can use this

command to build a live preview of the docs, which will then be available on

 by default.

```

bundle exec jekyll serve --watch --livereload

```

**NOTE**: Do not run this with the `--watch` flag while updating the generated

pages and images with the `update` script - it will lead to problems and broken

images.

When updating outdated documentation, please update the `updated: DATE` header

in markdown files accordingly.

### Automatically updating generated content

The report, PR report, overview, and backlog pages are automatically generated

from rawhide repository data, the list of packages currently maintained by this

SIG, open pull requests on SIG package repositories, and the curated data in

`data/events.json`.

To automatically check for new data, and update the pages accordingly, just run

the `./update` script. It has only a few requirements:

- `dnf`, `dnf-tools` and `fedora-repos-rawhide`

- `python >= 3.5`

- `jinja2`, `pandas`, `prettytable`, `requests`, `rpm` python3 modules

**NOTE**: @decathorpe has a cron job that does this automatically.