ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Denis Magda <dma...@apache.org>
Subject Re: Move documentation from readme.io to GitHub pages
Date Thu, 01 Feb 2018 23:05:45 GMT
Dmitriy,

We will do a research before jumping off the readme.io <http://readme.io/> train.

In addition, to the technical issues outlined in the ticket, readme.io <http://readme.io/>
doesn’t give a way to tell Google “Hey, Google, index only the latest docs' version! Ignore
specific versions”. As a result, the Internet is flooded with Ignite 1.1, 1.7, 1.9 versions
of the pages that pop up at the top of the search. You know this annoying thing better than
me :)

—
Denis

> On Feb 1, 2018, at 1:39 PM, Dmitriy Setrakyan <dsetrakyan@apache.org> wrote:
> 
> Guys, as I have been saying all along, we need to identify a documentation
> system we want to move to. Once we do that, we can plan how to move off of
> readme.
> 
> Again, the most important benefit readme has is instantaneous documentation
> update. However, on the downside, they do not integrate with Git well, and
> ASF wants all its projects to keep the documentation in Apache Git.
> 
> Does anyone have suggestions?
> 
> D.
> 
> On Thu, Feb 1, 2018 at 5:57 AM, Pavel Tupitsyn <ptupitsyn@apache.org> wrote:
> 
>> Good news, Denis.
>> 
>> By the way, readme.io uses some kind of markdown dialect, and they have
>> "export" feature,
>> so it should be possible to move to some markdown-based system like Jekyll
>> without too much hassle.
>> 
>> On Thu, Feb 1, 2018 at 2:18 AM, Denis Magda <dmagda@apache.org> wrote:
>> 
>>> Created a ticket. I think the time to move from readme.io <
>>> http://readme.io/> has come. It’s becoming too challenging to live with
>>> it:
>>> https://issues.apache.org/jira/browse/IGNITE-7595 <
>>> https://issues.apache.org/jira/browse/IGNITE-7595>
>>> 
>>> —
>>> Denis
>>> 
>>>> On Apr 13, 2017, at 8:25 AM, Dmitriy Setrakyan <dsetrakyan@apache.org>
>>> wrote:
>>>> 
>>>> On Wed, Apr 12, 2017 at 8:52 PM, Konstantin Boudnik <cos@apache.org>
>>> wrote:
>>>> 
>>>>> I hate to be that guy, but mentors warned this very project no to do
>>>>> this in the first place. At least once [1] on the dev@, and a few
>>>>> times off-line
>>>>> 
>>>> 
>>>> Cos, no doubt this had come up before (after all, we did have very good
>>>> mentors during the incubation process).
>>>> 
>>>> Unfortunately, for tasks like this it is never a good time. I hope
>>> someone
>>>> in the community picks it up, or at least gets started on it.
>>> 
>>> 
>> 


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message