I believe I mentioned this on the Titan or Tinkerpop mailing list but it was 
off-topic at the time, so I will restate here:


What about a pinned post on the gremlin-users mailing lists linking to the most 
recent docs and website as another guidepost for users in line with this one? 
Does this edit to all the old wikis etc. make such a thing redundant? My 
thinking on this is that it would be similar to the pinned post titled "On 
proper issue submission" at the top of the Titan mailing list - short and 
sweet, saving Tinker-time solving problems on the list that are not easily 
reproducible or particularly relevant/straightforward. It could also prevent 
some posts based on outdated information that beget more relevant questions 
posted deep down in the thread, which now has a misleading title that does not 
match the core of its content.

________________________________
From: Jean-Baptiste Musso <[email protected]>
Sent: Tuesday, June 7, 2016 4:05:16 PM
To: [email protected]
Subject: Documentation deprecation warning on Github Wikis

Dear devs,

I was thinking recently that we could add a deprecation warning
message on top of all former Github Wiki pages and warn visitors that
a new version of TinkerPop is available. I think this was also brought
up recently on the mailing list so I'm opening a discussion here.

I feel that some newcomers are still hitting old school TinkerPop 2
material when google'ing for graphs, Gremlin and TinkerPop. Adding a
warning message on top of old Wiki pages pointing them to the freshest
development on the Apache TinkerPop website could certainly help.

If everyone agrees, I'm volunteering to git clone the Wiki on all
repositories and edit all pages. As Stephen noted on HipChat, it's as
simple as following these steps:
https://help.github.com/articles/adding-and-editing-wiki-pages-locally/
Adding and editing wiki pages locally - User 
Documentation<https://help.github.com/articles/adding-and-editing-wiki-pages-locally/>
help.github.com
Cloning wikis locally to your computer. Every wiki provides an easy way to 
clone its contents down to your computer: If you're using GitHub Desktop, click 
Clone in ...




Here's an example of such header we could add:

https://gist.github.com/jbmusso/802cf97ceb20547ba6abf0b4112ac3ee

Thoughts? Feel free to iterate. The wording could be improved.

Cheers,

Jean-Baptiste

Reply via email to