Urgency of updating Mercurial website and initiate https://mercurial-scm.readthedocs.io ?

[PIERRE AUGIER]

Thanks Raphaël. Happy that you like this new website!

I addressed most of your comments in the MR and polished a bit to get a nicer result, which gives:

https://mercurial.pages.heptapod.net/hg-website/topic/default/with-sphinx/index.html

To finalize a first version I would need:

- two Mercurial logos compatible with dark and light themes (transparent background would be appreciated).
- list of nice projects and companies that are still using Mercurial. Since Firefox and PyPy switched to Git, we cannot really based our argumentation on these famous examples.

If this sphinx based website is used for https://www.mercurial-scm.org, I guess we will need to do something in terms of named branches and default branch in https://foss.heptapod.net/mercurial/hg-website.

I also created few issues that could be fixed later https://foss.heptapod.net/mercurial/hg-website/-/issues.

In my point of view, a real advantage of this solution is that it is much easier to modify than before.

Pierre

----- Mail original -----
> De: "Raphaël Gomès" <raphael.gomes at octobus.net>
> À: "mercurial-devel" <mercurial-devel at lists.mercurial-scm.org>
> Envoyé: Jeudi 2 Janvier 2025 11:35:10
> Objet: Re: Urgency of updating Mercurial website and initiate https://mercurial-scm.readthedocs.io ?

> I honestly think that it looks great and is already much better than
> what we have now. We could almost already replace the main site with
> this now and be better off for it, since the guide in the existing
> website is quite outdated.
> 
> I'm not sure about the documentation for evolve, topic and hg-git, maybe
> someone else can answer.
> 
> I have a few pieces of end-user feedback as well as code feedback, which
> I have left on the newly created MR¹.
> 
> [1] https://foss.heptapod.net/mercurial/hg-website/-/merge_requests/2
> 
> Thanks again.
> 
> On 12/28/24 10:38 PM, PIERRE AUGIER wrote:
>> I worked on a draft using Sphinx which can be seen here
>> https://mercurial.pages.heptapod.net/hg-website/topic/default/with-sphinx/index.html
>>
>> For now, it is very much inspired from the current website and it's not
>> beautiful. However, the sources
>> (https://foss.heptapod.net/mercurial/hg-website/-/tree/topic/default/with-sphinx)
>> are much simpler than the current website, so it is easier to maintain. Another
>> advantage is that there is no mention of python 2.3 :-)
>>
>> There is a documentation produced from `hg help` rst texts
>> (https://mercurial.pages.heptapod.net/hg-website/topic/default/with-sphinx/_generated/commands.html
>> and
>> https://mercurial.pages.heptapod.net/hg-website/topic/default/with-sphinx/_generated/topics.html).
>>
>> I have a question about the documentation of commands provided by evolve, topic
>> and hg-git. Is there a simple way to get the raw docstring from Python ?
>>
>> For the core commands and topics I use
>> https://foss.heptapod.net/mercurial/hg-website/-/blob/topic/default/with-sphinx/source/util_hg_website.py
>> but there might be a better way that would also work for commands and topics
>> provided by external extensions.
>>
>> Pierre
>>
>> ----- Mail original -----
>>> De: "Pierre-Yves David" <pierre-yves.david at octobus.net>
>>> À: "PIERRE AUGIER" <pierre.augier at univ-grenoble-alpes.fr>, "Mercurial Devel"
>>> <mercurial-devel at mercurial-scm.org>
>>> Envoyé: Samedi 21 Décembre 2024 16:45:49
>>> Objet: Re: Urgency of updating Mercurial website and initiate
>>> https://mercurial-scm.readthedocs.io ?
>>> On 12/20/24 15:47, PIERRE AUGIER wrote:
>>>> ----- Mail original -----
>>>>> De: "Pierre-Yves David"<pierre-yves.david at octobus.net>
>>>>> À: "PIERRE AUGIER"<pierre.augier at univ-grenoble-alpes.fr>, "Mercurial
>>>>> Devel"<mercurial-devel at mercurial-scm.org>
>>>>> Envoyé: Vendredi 20 Décembre 2024 15:34:33
>>>>> Objet: Re: Urgency of updating Mercurial website and
>>>>> initiatehttps://mercurial-scm.readthedocs.io ?
>>>>> Why do you need a new repository for that? I think we can reuse the
>>>>> existing website repository for the new version of the repository.
>>>> Because I was thinking that Mercurial maintainers want to
>>>> keephttps://www.mercurial-scm.org/ and that I could propose something else
>>>> hosted somewhere else.
>>>>
>>>> Ifhttps://www.mercurial-scm.org can be static (I think it can), I can also
>>>> propose something to replace it. However, I have to admit that I don't know
>>>> anything about web things. I just know how to produce documentation websites
>>>> based on Sphinx, myst and Jupyter. It would make sense to use such tools
>>>> because there is a lot of content in Mercurial source in rst and Sphinx knows
>>>> how to render that. For a project with not so much man power, it could make
>>>> sense to go in this direction.
>>>
>>> A good option for smaller iterative steps might be to start with this
>>> documentation focused "section" and link to it from the main site. Then
>>> update the rest of the main site. It would allow you to focus on what
>>> you are familiar with for now.
>>>
>>> As far as I understand, Raphaël is currently the one with most interest
>>> and knowledge about website, so I'll let him chime in when he is back
>>> from vacation.
>>>
>>>
>>>> I could reusehttps://foss.heptapod.net/mercurial/hg-website but there would be
>>>> first a big commit to remove everything :-) So it might make sense to start in
>>>> a new repo. I could also use a new name branch
>>>> inhttps://foss.heptapod.net/mercurial/hg-website. What do you think?
>>> We can start in a topic there, and decide if we want it to be named
>>> branch while it settle later.
>>>
>>> --
>>> Pierre-Yves David
>> _______________________________________________
>> Mercurial-devel mailing list
>> Mercurial-devel at lists.mercurial-scm.org
>> https://lists.mercurial-scm.org/mailman/listinfo/mercurial-devel
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel at lists.mercurial-scm.org
> https://lists.mercurial-scm.org/mailman/listinfo/mercurial-devel