Hi Ralph,
Okay, understood. I think, for me it makes sense to keep them under the main 
flume repo so that we can ensure that things are updated in-sync, unless they 
are release specific. For me this is the best way to ensure we retain good docs 
hygiene, otherwise we end up with a very real risk of them getting out of sync.

So a -0.9 from me on this.

Tristan
________________________________
From: Ralph Goers <ralph.go...@dslextreme.com>
Sent: 09 October 2022 00:18
To: dev@flume.apache.org <dev@flume.apache.org>
Subject: Re: [flume] branch trunk updated (413fb919b -> 7c3dedac7)

I’ve been update flume-site and the flume repo at the same time. In previous 
releases I found myself starting to get confused as to which one was current as 
I’ve been editing things as part of the release directly in flume-site. Since 
the copy in flume-site has to exist it just didn’t make sense to me to keep the 
one in the flume repo as it gives people the impression it is the master. About 
the only thing we get from the flume build now for the web site is the javadoc.

Sorry, I guess I should have mentioned it when I deleted the directory. I 
probably would have if there were more people committing.

FWIW, if you go though the Jira issues I would guess that at most 10% affect 
both the code and the doc. The vast majority are for only one or the other.

Ralph

> On Oct 8, 2022, at 2:09 PM, Tristan Stevens <tris...@apache.org> wrote:
>
> Hi Ralph,
> I assumed the commit was accidental as I hadn't seen any discussion or even a 
> PR. Surely this is the master copy as it's what we ask people to contribute 
> to when implementing new features or changing behaviour? My understanding is 
> that when we cut a release we copy a snapshot across.
>
> If I'm mistaken, then that's cool, but we need a way for PRs to cover changes 
> to the docs and the code at the same time.
>
> Tristan
>
> Get Outlook for Android<https://aka.ms/AAb9ysg>
>
> ________________________________
> From: Ralph Goers <ralph.go...@dslextreme.com>
> Sent: Saturday, 8 October 2022, 20:32
> To: dev@flume.apache.org <dev@flume.apache.org>
> Subject: Re: [flume] branch trunk updated (413fb919b -> 7c3dedac7)
>
> To be clear, you should have said something on the dev list before reverting 
> this.
>
> Ralph
>
>> On Oct 8, 2022, at 12:31 PM, Ralph Goers <ralph.go...@dslextreme.com> wrote:
>>
>> Why did you revert this? These are confusing as they are no longer used to 
>> build the web site. The source for the guides is in the flume-site repo.
>>
>> Ralph
>>
>>> On Oct 8, 2022, at 10:53 AM, tris...@apache.org wrote:
>>>
>>> This is an automated email from the ASF dual-hosted git repository.
>>>
>>> tristan pushed a change to branch trunk
>>> in repository https://gitbox.apache.org/repos/asf/flume.git
>>>
>>>
>>>  from 413fb919b Merge pull request #284 from liketic/bugfix-1
>>>   add 7c3dedac7 Revert "Remove user and dev guides"
>>>
>>> No new revisions were added by this update.
>>>
>>> Summary of changes:
>>> flume-ng-doc/sphinx/FlumeDeveloperGuide.rst      |  958 ++++
>>> flume-ng-doc/sphinx/FlumeUserGuide.rst           | 5633 
>>> ++++++++++++++++++++++
>>> flume-ng-doc/sphinx/conf.py                      |  108 +
>>> flume-ng-doc/sphinx/images/DevGuide_image00.png  |  Bin 0 -> 11849 bytes
>>> flume-ng-doc/sphinx/images/DevGuide_image01.png  |  Bin 0 -> 17014 bytes
>>> flume-ng-doc/sphinx/images/UserGuide_image00.png |  Bin 0 -> 14069 bytes
>>> flume-ng-doc/sphinx/images/UserGuide_image01.png |  Bin 0 -> 23462 bytes
>>> flume-ng-doc/sphinx/images/UserGuide_image02.png |  Bin 0 -> 37785 bytes
>>> flume-ng-doc/sphinx/images/UserGuide_image03.png |  Bin 0 -> 26105 bytes
>>> flume-ng-doc/sphinx/images/flume-logo.png        |  Bin 0 -> 33341 bytes
>>> flume-ng-doc/sphinx/index.rst                    |   60 +
>>> pom.xml                                          |    9 +
>>> 12 files changed, 6768 insertions(+)
>>> create mode 100644 flume-ng-doc/sphinx/FlumeDeveloperGuide.rst
>>> create mode 100644 flume-ng-doc/sphinx/FlumeUserGuide.rst
>>> create mode 100644 flume-ng-doc/sphinx/conf.py
>>> create mode 100755 flume-ng-doc/sphinx/images/DevGuide_image00.png
>>> create mode 100755 flume-ng-doc/sphinx/images/DevGuide_image01.png
>>> create mode 100755 flume-ng-doc/sphinx/images/UserGuide_image00.png
>>> create mode 100755 flume-ng-doc/sphinx/images/UserGuide_image01.png
>>> create mode 100755 flume-ng-doc/sphinx/images/UserGuide_image02.png
>>> create mode 100755 flume-ng-doc/sphinx/images/UserGuide_image03.png
>>> create mode 100644 flume-ng-doc/sphinx/images/flume-logo.png
>>> create mode 100644 flume-ng-doc/sphinx/index.rst
>>>
>>
>
>

Reply via email to