Re: [Mingw-cross-env-list] README in master but not in stable

[Volker Grabsch]

Tony Theodore schrieb:
> On 27 Feb 2014, at 17:29, Tony Theodore <address@hidden> wrote:
> > On 27 Feb 2014, at 16:59, Volker Grabsch <address@hidden> wrote:
> > 
> >> I'm not sure if these explainations about the lookup
> >> rules are already part of the docs. If not, I'd suggest
> >> to add them.
> > 
> > Good point, I haven’t even documented *.shared yet.
> 
> I think an ideal place for this would be in a README.md that people see on 
> github and the master branch, but isn’t in stable (or is a blank file). This 
> way we can make evolving development notes available before being finalised 
> and incorporated into the main docs. We could also add links to experimental 
> branches here and any other work-in-progress. Some of this may be relevant 
> across a merge-from-master so we can’t simply clear the file.
> 
> Is this a good idea? If so, is there a way to make git do this?

Back when I designed the schema of using index.html and
ensuring "stable = gh-pages", I had something slightly
different in mind:

I thought that all development notes should go into
index.html on master branch. On release (merge-from-master),
those become automatically the docs for the new stable
branch. A preview of the development docs would be
reachable locally, or via a URL like this:

http://htmlpreview.github.io/?https://raw.github.com/mxe/mxe/master/index.html

However, this assumed that the docs always describe
the _current_ state of development, not future
development.

Don't get me wrong. Describing future development
is really a good thing! However, doing that in the
master branch is something that breaks the whole
concept, and I'm not aware of any Git feature or
merge workflow that would fix this. (Except for some
nasty workflows that require lots of discipline
to get right.)

So for shaping concepts of future features, I'd
propose to use a separate place, such as the wiki
we already have.

However, as soon as things are getting implemented,
these docs should be moved into index.html of the
master branch. One such wiki page might also contain
a link list of experimental branches.

In the docs (of stable as well as master) we could
add a pointer to the wiki, as well as to the
above mentioned URL for viewing the current
development docs (index.html of the master branch).

Not sure if that's the best approach, but I think
it's a lot easier than trying to keep a permanent
difference between master and stable.


Regards,
Volker

-- 
Volker Grabsch
---<<(())>>---