trafodion-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gunnar Tapper <tapper.gun...@gmail.com>
Subject Re: Chinese Contributor Access
Date Fri, 15 Jul 2016 15:19:46 GMT
Hi Felix,

The documentation is part of the source code. You need to set up a build
environment and use the structure in the docs directory to build/create a
new document.

So, the "click a button to upload a document" consists of the same steps as
you do to upload code; that is, you modify and build source files and then
you submit your changes via git, which are then reviewed and merged in by a
committer. The documents are written in asciidoc and follow the
organization and build structure that already exist in the different
subdirectories in the docs directory.

I hope this helps,

Gunnar

On Fri, Jul 15, 2016 at 4:09 AM, Yang, Yang (Felix) <yang.yang@esgyn.cn>
wrote:

> Hi there,
> The cwiki link about document submission is horrible. It doesn't show
> people how to put their 1st article online.  I'm sure there is a button
> hidden somewhere for doc contributors to upload their article, or to create
> directories, but I just can't find it.
>
> Here is what we suggest how the Chinese translations could be submitted ,
> just to start discussion:
> Step 1: Shall we set up a new button/tab "中文“(Chinese) on document page,
> http://trafodion.apache.org/documentation.html, on the blue bar, behind
> "1.3.0 Release";
> Please find the "中文" in the enclosed screenshot ("Trafodion Chinese
> tab.jpg");
>
> Step 2:
> We could give a couple of Chinese contributors write privileges, starting
> with translations.  Now We have a Chinese wechat group on Trafodion, fellow
> Chinese contributors, please send an email to this list or to
> yang.yang@esgyn.cn to join the wechat group if you like.
>
> Step 3:
> Upload the translation.  Where is the button? is there an interface like
> in the attachment "submission page" ?  No, I'm not suggestion submitting to
> cwiki, but just the nice friendly interface to upload like that.
>
> To start with, all submissions in Chinese are translations from "Latest"
> tab only.  The order will be exactly the same.
>
> Best,
> Felix
>
>
> -----Original Message-----
> From: Gunnar Tapper [mailto:tapper.gunnar@gmail.com]
> Sent: Friday, July 15, 2016 3:05 AM
> To: dev@trafodion.incubator.apache.org
> Subject: Re: Chinese Contributor Access
>
> Hi,
>
> Start here:
> https://cwiki.apache.org/confluence/display/TRAFODION/Modify+Documentation
>
> Gunnar
>
> On Thu, Jul 14, 2016 at 8:02 AM, Liu, Yu (Yu) <yu.liu@esgyn.cn> wrote:
>
> > Hi all,
> > Thanks for your suggestion!
> > We will find a way which serves best.
> >
> > Hi Dave & Gunnar,
> > Currently we have some Chinese guides.
> > How can we upload/put these files to Apache Trafodion website?
> >
> > Many thanks!
> > Liu Yu
> >
> >
> > -----Original Message-----
> > From: Eric Owhadi [mailto:eric.owhadi@esgyn.com]
> > Sent: Thursday, July 14, 2016 9:41 PM
> > To: dev@trafodion.incubator.apache.org
> > Subject: RE: add a roadmap page in Trafodion's project page
> >
> > +1 on this,
> > Eric
> >
> > -----Original Message-----
> > From: Liu, Ming (Ming) [mailto:ming.liu@esgyn.cn]
> > Sent: Thursday, July 14, 2016 8:35 PM
> > To: dev@trafodion.incubator.apache.org
> > Subject: add a roadmap page in Trafodion's project page
> >
> > Hi, all,
> >
> > I suggest that Trafodion team should add a 'roadmap' page in the
> > project's front web page, so users will be clear what to expect in the
> future.
> > It will help decision making in some cases.
> >
> > Thanks,
> > Ming
> >
> > -----Original Message-----
> > From: Jin, Jian (Seth) [mailto:Jian.jin@esgyn.cn]
> > Sent: Thursday, July 14, 2016 12:26 PM
> > To: dev@trafodion.incubator.apache.org; tapper.gunnar@gmail.com
> > Subject: RE: Chinese Contributor Access
> >
> > This would be very user friendly.
> >
> > Br,
> >
> > Seth
> >
> > -----Original Message-----
> > From: Dave Birdsall [mailto:dave.birdsall@esgyn.com]
> > Sent: 2016年7月13日 23:20
> > To: dev@trafodion.incubator.apache.org; tapper.gunnar@gmail.com
> > Subject: RE: Chinese Contributor Access
> >
> > Hi,
> >
> > The two don't conflict.
> >
> > The source for documents can be in directories that mirror the English
> > ones.
> > Which is a good idea because it will be easier to keep them in synch.
> >
> > Links on the web pages and in documents on the other hand can go
> > transparently across Chinese directories. So to an end-user, it is
> > just as you describe: Click on the Chinese link on the main web page,
> > then travel to a collection of Chinese pages. Similarly for the
> documents.
> >
> > Dave
> >
> > -----Original Message-----
> > From: Liu, Yu (Yu) [mailto:yu.liu@esgyn.cn]
> > Sent: Wednesday, July 13, 2016 3:01 AM
> > To: tapper.gunnar@gmail.com; dev@trafodion.incubator.apache.org
> > Subject: RE: Chinese Contributor Access
> >
> > Hi Gunnar,
> >
> > Appreciate you taking time to provide your details! I will do more
> > research on them.
> >
> > One question: Why add Chinese directory that corresponds with the
> > English version rather than create a specific section/place?
> >
> > In the latter situation, Chinese (large number of users) could locate
> > their desired information with fastest and fewest clicks, the user
> > experience & user usability will be improved significantly,
> > consequently it will contribute to the promotion of Apache Trafodion
> website as well.
> >
> > Thanks!
> > Liu Yu
> >
> >
> > -----Original Message-----
> > From: Gunnar Tapper [mailto:tapper.gunnar@gmail.com]
> > Sent: Wednesday, July 13, 2016 11:26 AM
> > To: dev@trafodion.incubator.apache.org
> > Cc: Dave Birdsall <dave.birdsall@esgyn.com>; Jin, Jian (Seth) <
> > Jian.jin@esgyn.cn>; Yang, Yang (Felix) <yang.yang@esgyn.cn>
> > Subject: Re: Chinese Contributor Access
> >
> > Hi,
> >
> > It's definitely a good idea to add a set of Chinese-language pages and
> > user guides. Most of the documentation and web pages are located under
> > the docs/ directory. I propose that we keep this simple: simply add a
> > [document]_cn directory that corresponds with the English version. For
> > example, docs/sql_reference and docs/sql_reference_cn. The documents
> > are written in asciidoctor so I think we'll be OK there. The current
> > PDF tool will not do good so we'll probably need to change to
> > asciidoctor-fopub. See
> > http://programfan.github.io/contents/2015/04/20/convert-chinese-asciid
> > oc-to-pdf/
> >
> > The website uses markdown. From what I can see, this should work.
> > There's even a guide: http://markdown.tw/ Here, I propose that the
> > differnet web pages are complimented with a _cn counterpart. See
> > src/site/markdown/. We may have to do some css work, which I view as a
> > good thing since the current css definitions are really hacks.
> >
> > I hope this helps,
> >
> > Gunnar
> >
> >
> >
> > On Tue, Jul 12, 2016 at 9:10 PM, Liu, Yu (Yu) <yu.liu@esgyn.cn> wrote:
> >
> > > Hi Dava,
> > > Thanks for your details!
> > > We plan to upload Chinese reference manuals/website
> > > pages/guides/instructions/blogs/articles/… periodically.
> > > We will follow the instructions on the website to register.
> > >
> > > Hi all,
> > > One more question:
> > > China has been growing dramatically and enjoy tremendous potential,
> > > in order to benefit more people and grow more audience, and given
> > > that a wealth of Chinese documentation will be coming, thus could
> > > Apache Trafodion create a specific section/tab for Chinese files?
> > >
> > > Liu Yu
> > >
> > >
> > > -----Original Message-----
> > > From: Dave Birdsall [mailto:dave.birdsall@esgyn.com]
> > > Sent: Wednesday, July 13, 2016 12:18 AM
> > > To: dev@trafodion.incubator.apache.org
> > > Cc: Jin, Jian (Seth) <Jian.jin@esgyn.cn>; Yang, Yang (Felix) <
> > > yang.yang@esgyn.cn>
> > > Subject: RE: Chinese Contributor Access
> > >
> > > Hi Liu Yu,
> > >
> > >
> > >
> > > What sort of documentation do you wish to contribute? Wiki pages?
> > > Web site pages? Chinese versions of the reference manuals?
> > >
> > >
> > >
> > > An ICLA is a good idea for all of these. A JIRA ID is also a good
> > > idea for all of these; it is a good mechanism for tracking work.
> > >
> > >
> > >
> > > A Git ID is needed if you are doing web site pages or Chinese
> > > versions of the reference manuals, since the source for both of
> > > these is stored in Github.
> > >
> > >
> > >
> > > Dave
> > >
> > >
> > >
> > > *From:* Liu, Yu (Yu) [mailto:yu.liu@esgyn.cn]
> > > *Sent:* Monday, July 11, 2016 11:06 PM
> > > *To:* dev@trafodion.incubator.apache.org
> > > *Cc:* Jin, Jian (Seth) <Jian.jin@esgyn.cn>; Yang, Yang (Felix) <
> > > yang.yang@esgyn.cn>
> > > *Subject:* Chinese Contributor Access
> > >
> > >
> > >
> > > Hi Apache Trafodion,
> > >
> > >
> > >
> > > Sincerely appreciate your great efforts for Apache Trafodion Community.
> > >
> > >
> > >
> > > I’m Liu Yu who is a technical writer from Esgyn in China (Shanghai),
> > > along with some Chinese volunteers who are eager to get more
> > > involved and want to be contributors to Apache Trafodion Community.
> > >
> > >
> > >
> > > 1.    How can we publish Chinese documentations?
> > >
> > >
> > >
> > > 2.    Should we register as indicated below (screen short from website)
> > > *individually*? ICLA + Git  ID + Jira ID?
> > >
> > >
> > >
> > >
> > >
> > >
> > >
> > > Many thanks!
> > >
> > >
> > >
> > > Liu Yu
> > >
> >
> >
> >
> > --
> > Thanks,
> >
> > Gunnar
> > *If you think you can you can, if you think you can't you're right.*
> >
>
>
>
> --
> Thanks,
>
> Gunnar
> *If you think you can you can, if you think you can't you're right.*
>



-- 
Thanks,

Gunnar
*If you think you can you can, if you think you can't you're right.*

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