Prelude section name is causing confusion for new users

[Sean McGinnis]

I've had a lot of reviews where I've needed to correct the submitter because they didn't read the full documentation and assumed the "prelude" section was some kind of prelude to their specific note.

There's a common misunderstanding that text added to multiple sections somehow stays grouped in the resulting output, but at least for the prelude section, I think it might reduce these errors a little bit by either renaming "prelude" to something more specifically stating "project_wide_general_announcements". Or maybe adding more description to the sections sample text explaining this more, hoping that they actually read that part.

[Doug Hellmann (doug-hellmann)]

We could fix this by allowing that section name to be changed. We currently rely on the name to trigger special handling, so we would need to add another option to tell us which name should receive that special handling.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/475019

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/475019
Committed: https://git.openstack.org/cgit/openstack/reno/commit/?id=4003fc13210132e56040a90968fae653be3c88b3
Submitter: Jenkins
Branch: master

commit 4003fc13210132e56040a90968fae653be3c88b3
Author: Rajath Agasthya <email address hidden>
Date: Fri Jun 16 02:14:29 2017 -0700

    Allow users to change prelude section name

    Convert note template to a format string. Also include prelude
    section in the report generated and update docs.

    Closes-Bug: #1698203
    Change-Id: I7bef68bfb518dd8554d56cb200f2844e7d395fc8

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/reno 2.5.0 release.