[Gt-eos] GT Documentation and mailing lists

[Mischa Salle]

Hi,

On Thu, Dec 07, 2017 at 11:58:26AM +0100, Frank Scheiner wrote:
> Should we call for a vote about the adoption of the GT documentation or can
> we consider this part of the original Globus Toolkit and hence agreement to
> adoption is implicit?
I don't think anyone would disagree, so a vote seems not necessary.

> 
> ## Fork ##
> 
> Anyway I suggest to fork the same way as it was done for the Globus Toolkit,
> because then the search functionality on GitHub will also work in our forked
> code base. Comes in handy sometimes.
We could make it a 'simple' fork directly from github (which will show
up as 'forked from' and provides info on 'X commits behind / ahead). Or
do it from a cmdline, and set the other as upstream, without github
knowing about that. For gct we did the latter I think (as in
https://help.github.com/articles/duplicating-a-repository/)

> ## Old/unneeded information ##
> 
> There might be some or even a lot of information in the
> globus-toolkit-documentation that could be unneeded for our means, hence we
> could start a new branch in our fork and just import the needed information
> there. After everything is in shape, we could change the default branch for
> this repo to the new branch.
I would probably do that: fork and make a new branch to work on.

> ## Resulting documentation ##
> 
> For the "finalized" documentation I'm yet undecided:
> 
> * GitBook
> * ReadTheDocs
> * GitHub pages
> 
> The first two have the advantage to include search functionality, but there
> also seem to be "solutions" available that - with some manual work - provide
> search functionality within GitHub pages, too, e.g. [Jekyll Tipue Search].
I think github + readthedocs is a relatively straightforward way. For
Argus some people have also done that, see
https://github.com/argus-authz/argus-documentation/tree/master/source 
and
http://argus-documentation.readthedocs.io/en/stable/
it seems relatively straightforward. I have no strong preference as long
as it is relatively mainstream, to make it easier for people to work
with it and to have some trust in sustainability.
I personally don't know whether you could do things as a organization, I
think you can, I could ask around...

Cheers,
Mischa

> [Jekyll Tipue Search]: https://github.com/jekylltools/jekyll-tipuesearch)
> 
> In any case I created accounts on GitBook (gridcf as organization) and
> ReadTheDocs (gridcf as personal account - no organizations possible or I
> didn't find the relevant information) we can use.
> 
> Cheers,
> Frank
> 
> On 12/06/2017 08:37 PM, Mátyás Selmeci wrote:
> > Who's going to do this?
> > 
> > -Mat
> > 
> > On 11/30/2017 10:29 AM, Brian Lin wrote:
> > > Perfect, it sounds like we should fork this into the gct
> > > organization! Once that's done, it should be trivial to generate the
> > > HTML out of the asciidocs source and push them to github pages.
> > > 
> > > - Brian
> > > 
> > > On 11/30/2017 03:09 AM, Frank Scheiner wrote:
> > > > On 11/30/2017 10:07 AM, Oliver Keeble wrote:
> > > > > > "Translating" from AsciiDoc to Markdown should be even
> > > > > > easier, but where can the AsciiDoc sources be found?
> > > > > 
> > > > > In the docs git repo, e.g. the text files here;
> > > > > 
> > > > > https://github.com/globus/globus-toolkit-documentation/tree/master/toolkit/docs/6.0/gridftp
> > > > 
> > > > 
> > > > 
> > > > Thanks for the pointer. :-)
> > > > 
> > > > Cheers,
> > > > Frank
> > _______________________________________________
> > Gt-eos mailing list
> > Gt-eos at mailman.egi.eu
> > http://mailman.egi.eu/mailman/listinfo/gt-eos
> 
> -- 
> Frank Scheiner
> 
> High Performance Computing Center Stuttgart (HLRS)
> Department Project User Management & Accounting
> 
> Email: scheiner at hlrs.de
> Phone: +49 711 685 68039
> 



> _______________________________________________
> Gt-eos mailing list
> Gt-eos at mailman.egi.eu
> http://mailman.egi.eu/mailman/listinfo/gt-eos


-- 
Nikhef                      Room  H155
Science Park 105            Tel.  +31-20-592 5102
1098 XG Amsterdam           Fax   +31-20-592 5155
The Netherlands             Email msalle at nikhef.nl
  __ .. ... _._. .... ._  ... ._ ._.. ._.. .._..
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/x-pkcs7-signature
Size: 3402 bytes
Desc: not available
URL: <http://mailman.egi.eu/pipermail/gt-eos/attachments/20171207/1f9775ea/attachment.p7s>