You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@aurora.apache.org by Bill Farner <wf...@apache.org> on 2016/03/14 21:27:47 UTC
[PROPOSAL] Rename NEWS to RELEASE-NOTES.md
Our NEWS file has turned into a useful source of information, but i think
the name doesn't clearly illustrate its purpose. Since we have been
primarily using it to manage release notes, i propose we rename the file to
RELEASE-NOTES.md.
As the name implies, i also propose that we formally use markdown syntax.
This will make for more natural linking to other docs, and direct posting
to our blog at release time (this is currently a manual process,
translating NEWS to markdown).
Re: [PROPOSAL] Rename NEWS to RELEASE-NOTES.md
Posted by Bill Farner <wf...@apache.org>.
Patch is up here: https://reviews.apache.org/r/44806/
On Mon, Mar 14, 2016 at 1:40 PM, Maxim Khutornenko <ma...@apache.org> wrote:
> +1 to both.
>
> On Mon, Mar 14, 2016 at 1:27 PM, Bill Farner <wf...@apache.org> wrote:
> > Our NEWS file has turned into a useful source of information, but i think
> > the name doesn't clearly illustrate its purpose. Since we have been
> > primarily using it to manage release notes, i propose we rename the file
> to
> > RELEASE-NOTES.md.
> >
> > As the name implies, i also propose that we formally use markdown syntax.
> > This will make for more natural linking to other docs, and direct posting
> > to our blog at release time (this is currently a manual process,
> > translating NEWS to markdown).
>
Re: [PROPOSAL] Rename NEWS to RELEASE-NOTES.md
Posted by Maxim Khutornenko <ma...@apache.org>.
+1 to both.
On Mon, Mar 14, 2016 at 1:27 PM, Bill Farner <wf...@apache.org> wrote:
> Our NEWS file has turned into a useful source of information, but i think
> the name doesn't clearly illustrate its purpose. Since we have been
> primarily using it to manage release notes, i propose we rename the file to
> RELEASE-NOTES.md.
>
> As the name implies, i also propose that we formally use markdown syntax.
> This will make for more natural linking to other docs, and direct posting
> to our blog at release time (this is currently a manual process,
> translating NEWS to markdown).
Re: [PROPOSAL] Rename NEWS to RELEASE-NOTES.md
Posted by Bill Farner <wf...@apache.org>.
Thanks for the feedback, folks. This patch has landed.
On Mon, Mar 14, 2016 at 6:00 PM, Jake Farrell <jf...@apache.org> wrote:
> LICENSE and NOTICE are the only 2 required named files within the release.
> The changelog is an optional item and can be named whatever we like, +1 to
> making it easier to understand its purpose
>
> -Jake
>
> On Mon, Mar 14, 2016 at 4:27 PM, Bill Farner <wf...@apache.org> wrote:
>
> > Our NEWS file has turned into a useful source of information, but i think
> > the name doesn't clearly illustrate its purpose. Since we have been
> > primarily using it to manage release notes, i propose we rename the file
> to
> > RELEASE-NOTES.md.
> >
> > As the name implies, i also propose that we formally use markdown syntax.
> > This will make for more natural linking to other docs, and direct posting
> > to our blog at release time (this is currently a manual process,
> > translating NEWS to markdown).
> >
>
Re: [PROPOSAL] Rename NEWS to RELEASE-NOTES.md
Posted by Jake Farrell <jf...@apache.org>.
LICENSE and NOTICE are the only 2 required named files within the release.
The changelog is an optional item and can be named whatever we like, +1 to
making it easier to understand its purpose
-Jake
On Mon, Mar 14, 2016 at 4:27 PM, Bill Farner <wf...@apache.org> wrote:
> Our NEWS file has turned into a useful source of information, but i think
> the name doesn't clearly illustrate its purpose. Since we have been
> primarily using it to manage release notes, i propose we rename the file to
> RELEASE-NOTES.md.
>
> As the name implies, i also propose that we formally use markdown syntax.
> This will make for more natural linking to other docs, and direct posting
> to our blog at release time (this is currently a manual process,
> translating NEWS to markdown).
>