Mercurial book (v2)

[Mathias De Maré]

On Thu, Sep 17, 2015 at 11:37 PM, Sean Farley <sean at farley.io> wrote:

>
> Gregory Szorc <gregory.szorc at gmail.com> writes:
>
> > On Wed, Sep 16, 2015 at 12:03 PM, Pierre-Yves David <
> > pierre-yves.david at ens-lyon.org> wrote:
> >
> >>
> >>
> >> On 09/15/2015 08:18 AM, Mathias De Maré wrote:
> >>
> >>> Hello everyone,
> >>>
> >>> a couple of months ago, I started working on getting the Mercurial book
> >>> to build again.
> >>> Currently, I have the English version working and translations work in
> >>> theory (currently, it's only the Chinese version, and that appears to
> >>> have some Glyphs problems).
> >>> Additionally, I set up a webserver and got the comment system up and
> >>> running on http://178.62.205.21/ . I also took the liberty of
> reserving
> >>> hgbook.org <http://hgbook.org> (since it was still available).
> >>> My code is available at https://bitbucket.org/Mathiasdm/hgbook .
> >>>
> >>
> >> Awesome, is your hosting simple and stable or do you need a better
> >> solution?
> >>
> >> Nice job fro grabbing hgbook.org we'll probably want to get that under
> >> project control at some point.
> >>
> >> The current state of the book:
> >>> - Updated parts of chapter 1, improving some of the information on
> other
> >>> version control systems and addressing comments in general.
> >>> - Updated the start of chapter 2, referencing correct URL's and
> >>> mentioning more tools than only TortoiseHg.
> >>> - Started work on a new chapter that focuses specifically on scaling
> >>> Mercurial. So far, it contains information on largefiles and
> >>> remotefilelog.
> >>>
> >>
> >> A chapter about phases would be nice. I've meant to translate this
> series
> >> of post into a chapter for quite some time, but I'll realistically not
> get
> >> to it any time soon:
> >>
> >> https://www.logilab.org/blogentry/88203
> >>
> >> I also contacted Bryan a while ago. He mentioned the possibility of
> >>> moving to a Creative Commons license for increased flexibility. I
> >>> haven't heard back regarding that option, but I hear Bryan's quite a
> >>> busy guy.
> >>>
> >>
> >> I'll try to ambush him in person.
> >>
> >> Obviously, there's plenty to be done. Some things are listed already at
> >>> https://bitbucket.org/Mathiasdm/hgbook/issues?status=new&status=open .
> >>> Contributors are very much welcome!
> >>> I would propose if you are starting on a specific task to assign
> >>> yourself to it (and create a new task if it doesn't exist yet). This
> >>> way, we can avoid duplicating work.
> >>> There's still an hgbook mailing list (from the previous effort to
> update
> >>> the book, I think). I'd like to propose we use that for hgbook-related
> >>> discussions: https://www.selenic.com/mailman/listinfo/mercurial-book
> >>>
> >>
> >> Depends on the actual traffic, but if it stay descent mercurial-devel
> >> might be a better place for that.
> >>
> >> I think it can also be useful to discuss work on the new book as part of
> >>> the sprint for 3.6, so I added that as a topic.
> >>>
> >>
> >> +1
> >>
> >> If anyone feels like contributing, please let me know :-) For myself,
> >>> the first upcoming tasks are to address comments throughout the book
> and
> >>> to add a new chapter on subrepos.
> >>>
> >>
> >> Thanks for doing this ☺
> >
> >
> > There was also in effort (spearheaded by Sean Farley IIRC) to rewrite the
> > book. Somewhere there's a "hgbook2" repository. My browser history tells
> me
> > it's on smf.io, where it is currently 403ing. I have a local clone I
> could
> > push somewhere if needed...
> >
> > smf?
>
> It was going to be a complete rewrite ... but that was too daunting a
> task it seems. I'd rather move the current version of the book to
> something like sphinx, then add changes. Seems like the challenge would
> be transferring the comments.
>

The different paragraphs in the book are hashed to give them a unique id on
the website. The comments are associated with this hash (so when the text
of a paragraph changes, the comments are assumed to be 'handled' and
disappear).
So it should be possible to convert the book to markdown, rst, asciidoc
(whichever is more suitable) and add an intermediate step back to docbook
to still generate the website with comments and all. That does assume that
the conversion results in unchanged comments (not sure how likely that is).
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://selenic.com/pipermail/mercurial-devel/attachments/20150920/b9c329d9/attachment.html>