You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flex.apache.org by Justin Mclean <ju...@classsoftware.com> on 2013/01/08 22:41:13 UTC

README and RELEASE_NOTES file names

Hi,

Any reason the README and RELEASE_NOTES in dist have been renamed READme.txt and RELEASE_NOTES.txt? There file names are referred to by name in several places.

Justin

Re: README and RELEASE_NOTES file names

Posted by Carol Frampton <cf...@adobe.com>.
Like I said several entries back the kit should have a README and it
should go to the dist directory.  Right beside it there should be a copy
of the same file called READme.  This file is not in the source kit.  We
should make a copy of README when we push the files to dist.  The links
will work to README although it doesn't show in the directory listing and
the READme will show in the directory listing.

I had a discussion with infra.  No, we can not get README to show up.

Carol

On 1/8/13 7 :36PM, "Justin Mclean" <ju...@classsoftware.com> wrote:

>Hi,
>
>> When you made the 4.9.0 release, you probably just updated the link,
>>but we
>> never had README in the 4.9.0 release.
>We did it just was renamed in the dist area to READme.txt.
>
>> We really need to have a note about this in the Release Guide.
>The release guide currently specifies README and RELEASE_NOTES.
>
>Justin
>


Re: README and RELEASE_NOTES file names

Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,

> When you made the 4.9.0 release, you probably just updated the link, but we
> never had README in the 4.9.0 release. 
We did it just was renamed in the dist area to READme.txt.

> We really need to have a note about this in the Release Guide.
The release guide currently specifies README and RELEASE_NOTES.

Justin


Re: README and RELEASE_NOTES file names

Posted by Om <bi...@gmail.com>.
On Tue, Jan 8, 2013 at 4:18 PM, Om <bi...@gmail.com> wrote:

> On Tue, Jan 8, 2013 at 4:11 PM, Justin Mclean <ju...@classsoftware.com>wrote:
>
>> Hi,
>>
>> > The links should work fine.  It is just that the file README does not
>> show
>> > up in the directory listing.  For example the directory listing at:
>> > http://www.apache.org/dist/flex/4.9.0/ does not appear to have a
>> README.
>> >
>> > But the link: http://www.apache.org/dist/flex/4.9.0/README works just
>> fine.
>>
>> Yep that's because I added the file about an hour ago. They weren't
>> working before that. :-)
>>
>> Justin
>
>
> I remember that it used to work fine with 4.8.0.  I believe things broke
> either during the move from incubator to flex or when we updated the site
> to point to 4.9.0 from the earlier 4.80 release.
>
> BTW, did we lose all history in SVN when we were promoted to a TLP?
>

Never mind.  I unselected "Stop on copy/rename" in the "Show Log" window in
TortoiseSVN.  That brought up the whole history.

BTW, Nick had fixed the link to
http://www.apache.org/dist/incubator/flex/4.8.0-incubating/README in rev:
1363888
And the link does work.

When you made the 4.9.0 release, you probably just updated the link, but we
never had README in the 4.9.0 release.   Which is why the link was broken.

We really need to have a note about this in the Release Guide.

Re: README and RELEASE_NOTES file names

Posted by Alex Harui <ah...@adobe.com>.


On 1/8/13 4:18 PM, "Om" <bi...@gmail.com> wrote:

> On Tue, Jan 8, 2013 at 4:11 PM, Justin Mclean <ju...@classsoftware.com>wrote:
> 
>> Hi,
>> 
>>> The links should work fine.  It is just that the file README does not
>> show
>>> up in the directory listing.  For example the directory listing at:
>>> http://www.apache.org/dist/flex/4.9.0/ does not appear to have a README.
>>> 
>>> But the link: http://www.apache.org/dist/flex/4.9.0/README works just
>> fine.
>> 
>> Yep that's because I added the file about an hour ago. They weren't
>> working before that. :-)
>> 
>> Justin
> 
> 
> I remember that it used to work fine with 4.8.0.  I believe things broke
> either during the move from incubator to flex or when we updated the site
> to point to 4.9.0 from the earlier 4.80 release.
> 
> BTW, did we lose all history in SVN when we were promoted to a TLP?
No, I see history.  Make sure you ask to see log past copy events.

-- 
Alex Harui
Flex SDK Team
Adobe Systems, Inc.
http://blogs.adobe.com/aharui


Re: README and RELEASE_NOTES file names

Posted by Om <bi...@gmail.com>.
On Tue, Jan 8, 2013 at 4:11 PM, Justin Mclean <ju...@classsoftware.com>wrote:

> Hi,
>
> > The links should work fine.  It is just that the file README does not
> show
> > up in the directory listing.  For example the directory listing at:
> > http://www.apache.org/dist/flex/4.9.0/ does not appear to have a README.
> >
> > But the link: http://www.apache.org/dist/flex/4.9.0/README works just
> fine.
>
> Yep that's because I added the file about an hour ago. They weren't
> working before that. :-)
>
> Justin


I remember that it used to work fine with 4.8.0.  I believe things broke
either during the move from incubator to flex or when we updated the site
to point to 4.9.0 from the earlier 4.80 release.

BTW, did we lose all history in SVN when we were promoted to a TLP?

Re: README and RELEASE_NOTES file names

Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,

> The links should work fine.  It is just that the file README does not show
> up in the directory listing.  For example the directory listing at:
> http://www.apache.org/dist/flex/4.9.0/ does not appear to have a README.
> 
> But the link: http://www.apache.org/dist/flex/4.9.0/README works just fine.

Yep that's because I added the file about an hour ago. They weren't working before that. :-)

Justin

Re: README and RELEASE_NOTES file names

Posted by Om <bi...@gmail.com>.
On Tue, Jan 8, 2013 at 3:59 PM, Alex Harui <ah...@adobe.com> wrote:

>
>
>
> On 1/8/13 3:55 PM, "Justin Mclean" <ju...@classsoftware.com> wrote:
>
> > Hi,
> >
> >> I think we tried but it doesn't work.  I agree that the two files
> should not
> >> have .txt suffixes.  But what breaks if README is called READme?
> >
> > Links on the web site and all places were we refer to the file by name as
> > README.
> So these were all broken for 4.8?  Or did we set the href to READme and
> leave the text as README?
>
> --
> Alex Harui
> Flex SDK Team
> Adobe Systems, Inc.
> http://blogs.adobe.com/aharui
>
>
The links should work fine.  It is just that the file README does not show
up in the directory listing.  For example the directory listing at:
http://www.apache.org/dist/flex/4.9.0/ does not appear to have a README.

But the link: http://www.apache.org/dist/flex/4.9.0/README works just fine.


We use this link from our site, see an example here:
http://flex.apache.org/download.html

Re: README and RELEASE_NOTES file names

Posted by Alex Harui <ah...@adobe.com>.


On 1/8/13 4:10 PM, "Justin Mclean" <ju...@classsoftware.com> wrote:

> Hi,
> 
>> So these were all broken for 4.8?  Or did we set the href to READme and
>> leave the text as README?
> 
> Probably broken - the links I could find were was to README not READme or
> READme.txt.
OK.  I thought we decided to use READme so there would it would be in the
dir listing if you looked.  I don't see any standard in other project's
releases, so I guess I don't really care what you do.

-- 
Alex Harui
Flex SDK Team
Adobe Systems, Inc.
http://blogs.adobe.com/aharui


Re: README and RELEASE_NOTES file names

Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,

> So these were all broken for 4.8?  Or did we set the href to READme and
> leave the text as README?

Probably broken - the links I could find were was to README not READme or READme.txt.

Justin



Re: README and RELEASE_NOTES file names

Posted by Alex Harui <ah...@adobe.com>.


On 1/8/13 3:55 PM, "Justin Mclean" <ju...@classsoftware.com> wrote:

> Hi,
> 
>> I think we tried but it doesn't work.  I agree that the two files should not
>> have .txt suffixes.  But what breaks if README is called READme?
> 
> Links on the web site and all places were we refer to the file by name as
> README.
So these were all broken for 4.8?  Or did we set the href to READme and
leave the text as README?

-- 
Alex Harui
Flex SDK Team
Adobe Systems, Inc.
http://blogs.adobe.com/aharui


Re: README and RELEASE_NOTES file names

Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,

> I think we tried but it doesn't work.  I agree that the two files should not
> have .txt suffixes.  But what breaks if README is called READme?

Links on the web site and all places were we refer to the file by name as README.

Justin

Re: README and RELEASE_NOTES file names

Posted by Alex Harui <ah...@adobe.com>.


On 1/8/13 3:40 PM, "Justin Mclean" <ju...@classsoftware.com> wrote:

> Hi,
> 
>> For now I think README, RELEASE_NOTES and READme should exist in diet.
> 
> For the moment I've copied READme.txt to README and RELEASE_NOTES.txt to
> RELEASE_NOTES to fix broken links but left the two .txt files there.
> 
> Do we know if we can get README to show up in the listing somehow?
> 
I think we tried but it doesn't work.  I agree that the two files should not
have .txt suffixes.  But what breaks if README is called READme?  Didn't 4.8
ship like that?

-- 
Alex Harui
Flex SDK Team
Adobe Systems, Inc.
http://blogs.adobe.com/aharui


Re: README and RELEASE_NOTES file names

Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,

> For now I think README, RELEASE_NOTES and READme should exist in diet.

For the moment I've copied READme.txt to README and RELEASE_NOTES.txt to RELEASE_NOTES to fix broken links but left the two .txt files there.

Do we know if we can get README to show up in the listing somehow?

Thanks,
Justin

Re: README and RELEASE_NOTES file names

Posted by Carol Frampton <cf...@adobe.com>.
For now I think README, RELEASE_NOTES and READme should exist in diet.

Carol 

On 1/8/13 5 :00PM, "Justin Mclean" <ju...@classsoftware.com> wrote:

>Hi,
>
>> Wasn't that because the HTTPd was hiding them from the index pages?
>
>It does hide README (but it still works) and doesn't hide RELEASE_NOTES.
>
>I would of thought not breaking site links was more important that
>showing the files on the index page. How many users would even see the
>index page?
>
>Probably a better solution is to something along the lines of what Apache
>HTTP does:
>http://apache.org/dist/httpd/
>
>Thanks,
>Justin


Re: README and RELEASE_NOTES file names

Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,

> Wasn't that because the HTTPd was hiding them from the index pages?

It does hide README (but it still works) and doesn't hide RELEASE_NOTES.

I would of thought not breaking site links was more important that showing the files on the index page. How many users would even see the index page?

Probably a better solution is to something along the lines of what Apache HTTP does:
http://apache.org/dist/httpd/

Thanks,
Justin

Re: README and RELEASE_NOTES file names

Posted by Nicholas Kwiatkowski <ni...@spoon.as>.
Wasn't that because the HTTPd was hiding them from the index pages?

-Nick

On Tue, Jan 8, 2013 at 4:41 PM, Justin Mclean <ju...@classsoftware.com>wrote:

> Hi,
>
> Any reason the README and RELEASE_NOTES in dist have been renamed
> READme.txt and RELEASE_NOTES.txt? There file names are referred to by name
> in several places.
>
> Justin