Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2022-03-04 Thread Joonas Niilola
On 4.3.2022 2.35, Ionen Wolkens wrote: > On Tue, Oct 05, 2021 at 02:21:22PM -0700, Alec Warner wrote: >> I'd argue we can add NOTES.md to packages (e.g. allow those files.) >> Then we modify packages.gentoo.org to render the markdown; or users >> can render locally or read unrendered. >> >> WDYT?

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2022-03-03 Thread Ionen Wolkens
On Tue, Oct 05, 2021 at 02:21:22PM -0700, Alec Warner wrote: > I'd argue we can add NOTES.md to packages (e.g. allow those files.) > Then we modify packages.gentoo.org to render the markdown; or users > can render locally or read unrendered. > > WDYT? Given this topic came up again on IRC, late

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-07 Thread Ulrich Mueller
> On Thu, 07 Oct 2021, Matthew Marchese wrote: > I also like the idea of markdown files or RST files living in > gentoo::. I personally find RST to be a bit more challenging to write, > but it's simple enough to learn and we 'already have RST to HTML > conversion on www.g.o for GLEPs. GitHub

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-07 Thread Matthew Marchese
On 10/5/21 12:09, Michał Górny wrote: On Tue, 2021-10-05 at 19:27 +0100, Sam James wrote: This is a preliminary version/draft of a proposed change to GLEP 68. I'd like to introduce a method for developers to signal anything special about a package and how to correctly maintain it. Sam James

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-06 Thread Ulrich Mueller
> On Wed, 06 Oct 2021, Alec Warner wrote: > On Tue, Oct 5, 2021 at 10:37 PM Ulrich Mueller wrote: >> How would you deal with translations? One NOTES file for every language? > The notes files are for devs, not for users. Do we have non-english > speaking developers? Sure, this is a

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-06 Thread Alec Warner
On Tue, Oct 5, 2021 at 10:37 PM Ulrich Mueller wrote: > > > On Tue, 05 Oct 2021, Alec Warner wrote: > > > I'd argue we can add NOTES.md to packages (e.g. allow those files.) > > Then we modify packages.gentoo.org to render the markdown; or users > > can render locally or read unrendered. > >

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-05 Thread Ulrich Mueller
> On Tue, 05 Oct 2021, Alec Warner wrote: > I'd argue we can add NOTES.md to packages (e.g. allow those files.) > Then we modify packages.gentoo.org to render the markdown; or users > can render locally or read unrendered. How would you deal with translations? One NOTES file for every

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-05 Thread Ulrich Mueller
> On Tue, 05 Oct 2021, Michał Górny wrote: > On Tue, 2021-10-05 at 19:27 +0100, Sam James wrote: >> This is a preliminary version/draft of a proposed change to >> GLEP 68. >> >> I'd like to introduce a method for developers to signal anything >> special about a package and how to correctly

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-05 Thread Joshua Kinard
On 10/5/2021 16:29, Alec Warner wrote: > I thought we were going to go with the github-pages type route > (markdown, rendered online or locally.) > > -A > > On Tue, Oct 5, 2021 at 11:28 AM Sam James wrote: >> >> This is a preliminary version/draft of a proposed change to >> GLEP 68. >> >> I'd

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-05 Thread Alec Warner
On Tue, Oct 5, 2021 at 1:36 PM Sam James wrote: > > > > > On 5 Oct 2021, at 21:29, Alec Warner wrote: > > > > I thought we were going to go with the github-pages type route > > (markdown, rendered online or locally.) > > > > So, the thinking was, we could allow somewhat shorthand > notes or for

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-05 Thread Sam James
> On 5 Oct 2021, at 21:29, Alec Warner wrote: > > I thought we were going to go with the github-pages type route > (markdown, rendered online or locally.) > So, the thinking was, we could allow somewhat shorthand notes or for the people who want to invest more time, allow the GitHub-pages

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-05 Thread Alec Warner
I thought we were going to go with the github-pages type route (markdown, rendered online or locally.) -A On Tue, Oct 5, 2021 at 11:28 AM Sam James wrote: > > This is a preliminary version/draft of a proposed change to > GLEP 68. > > I'd like to introduce a method for developers to signal

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-05 Thread Alessandro Barbieri
> Maybe we could just add README files to the package directories > in question. This would have the clear advantage that the files will be > immediately visible. > I'll personally prefer a readme. Also almost all metadata.xml features are underused >

Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-05 Thread Michał Górny
On Tue, 2021-10-05 at 19:27 +0100, Sam James wrote: > This is a preliminary version/draft of a proposed change to > GLEP 68. > > I'd like to introduce a method for developers to signal anything > special about a package and how to correctly maintain it. > > Sam James (1): > glep-0068: Add

[gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

2021-10-05 Thread Sam James
This is a preliminary version/draft of a proposed change to GLEP 68. I'd like to introduce a method for developers to signal anything special about a package and how to correctly maintain it. Sam James (1): glep-0068: Add notes element for package maintenance instructions glep-0068.rst | 26