#252 1.34 Release
Merged by cqi. Opened by cqi.
cqi/fedpkg release-1.34  into  master

Download 252.patch

From this release, release notes move to a documentation website
generated by sphinx, into which more content about fedpkg could be put
in the future.

Change logs are moved from CHANGELOG.rst to separate release notes, each
of them is a standalone web page in the site.

Command request-repo help text is updated as well.

Signed-off-by: Chenxiong Qi cqi@redhat.com

:thumbsup: from me. Is it possible to include #253 in the release as well?

Yes. #253 is merged.

make html show one warning:
copying static files... WARNING: html_static_path entry u'/root/src/fedpkg/doc/source/_static does not exist
it can be avoided by crateing empty _static directory.

question: should these lines to be changed everytime new build is released?

To summarize, for adding documentation for new release I should:

  • add new release to doc/source/releases.rst
  • modify/increment doc/source/conf.py
  • add new release documentation to doc/source/releases
  • make html
  • publish documentation as per https://pagure.io/docs/fedpkg/
  • something like pungi/doc/update-docs.sh would be useful for fedpkg.
  • it appears at https://pagure.io/docs/fedpkg/

Is it correct? Anything else?

By the way it looks very good.

minor suggestion: Why do we have to update it every year?
copyright = '{0}, fedpkg Team'.format(datetime.date.today().year)
plus corresponding import datetime of course.

question: should these lines to be changed everytime new build is released?

Yes.

To summarize, for adding documentation for new release I should:

add new release to doc/source/releases.rst
modify/increment doc/source/conf.py
add new release documentation to doc/source/releases
make html
publish documentation as per https://pagure.io/docs/fedpkg/
something like pungi/doc/update-docs.sh would be useful for fedpkg.

Yes. The script looks general for any project hosted in pagure.io and publish docs to docs.pagure.io :)

it appears at https://pagure.io/docs/fedpkg/

Is it correct? Anything else?

Yes. Should be nothing else. I actually plan update rpkg-ci to generate as much as content of release reStructuredText file automatically.

[1] https://pagure.io/rpkg-ci/issue/3

minor suggestion: Why do we have to update it every year?

To be honest, I'm not 100% sure the year should be updated every year. Probably we could just keep this literal year here for now.

rebased onto d1171eab8a693882e93a56a32a6d45db76f5cf86

make html show one warning:
copying static files... WARNING: html_static_path entry u'/root/src/fedpkg/doc/source/_static does not exist
it can be avoided by crateing empty _static directory.

Put a placeholder file in _static to include this directory in source code.

rebased onto f44c97f6777861ff8de97191cc85dd5836bd92c3

OK, for me it is ready to be merged.

Pull-Request has been merged by cqi

Metadata