⇐ ⇒

[CF-metadata] How to help correct problems with CF documents on github

From: Jeffrey F. Painter <painter1>
Date: Thu, 17 Apr 2014 09:57:01 -0700

Rich,

The originals of the CF Conventions document and some others are in the
repository "repository-cf".
The DocBook files there are used to generate the html and pdf files in
the cf-documents repository. The sources for the web site itself are
in the cf-convention.github.io repository. Matthew Harris (mostly) and
I have done some hand tweaking at several points because Jekyll
(github's markdown processor) and github's server have difficulties with
complicated documents. Automating and documenting this is on our to-do
list.

Frankly, it isn't always clear to me which repository to work on when
there is a problem. We recently had a problem with the html version of
chapter 9 (which has complicated tables). I looked at all three
repositories in order to get part-way towards a diagnosis the problem.
I don't know which ones Matthew worked on when he fixed the problem, but
I don't think he touched repository-cf.

- Jeff

On 4/17/14 7:47 AM, Signell, Richard wrote:
> I might have missed it, but I still don't think my original question
> has been answered:
>
> So if we see a problem with pages on http://cf-convention.github.io/,
> which github repo are we supposed to send a pull request to?
>
> It's hard for me to tell which repo has the origin documents from
> which all else is created.
>
> Thanks,
> Rich
>
> On Wed, Apr 16, 2014 at 7:29 PM, Jeffrey F. Painter<painter1 at llnl.gov> wrote:
>> John,
>>
>> Yes, the name cf-pcmdi.llnl.gov has been redirected to kitt.llnl.gov so that
>> cf-pcmdi.llnl.gov/trac is really the same as kitt.llnl.gov/trac. You can
>> tell because I just fixed your issue 4 on kitt, and now it's equally fixed
>> in both places.
>>
>> The machine which was formerly cf-pcmdi.llnl.gov has very thoroughly died,
>> although we have all the data that was on it.
>>
>> - Jeff
>>
>>
>> On 4/16/14 4:18 PM, John Graybeal wrote:
>>> This was very helpful, thanks Jeff. I think it is complete with respect to
>>> the concerns I raised.
>>>
>>> A worry I had about the two trac sites was that peoople might update the
>>> 'wrong' one. But I see now they are the same content, so it is presumaby
>>> just one site with some mapping under the hood to serve it two places. That
>>> will work, so long as people know that's the deal.
>>>
>>> Let us know when you are ready for attention on the CF Conventions
>>> document, and what kind of work it needs.
>>>
>>> John
>>>
>>> On Apr 16, 2014, at 15:59, "Jeffrey F. Painter"<painter1 at llnl.gov> wrote:
>>>
>>>> Rebuilding the CF Conventions web site is one of several things we're
>>>> doing at PCMDI/LLNL to recover from a storm of hardware and software
>>>> failures.
>>>>
>>>> Indeed the Trac system is up and you can get to it at
>>>> http://kitt.llnl.gov/trac. This is the official site in the sense that
>>>> contributions here will be preserved. But there's a reason why this url
>>>> hasn't been advertised. As we figure out how to reconfigure things, we
>>>> might decide to move the Trac system to another host. So please don't
>>>> bookmark that address. Instead, bookmark
>>>> http://cf-convention.github.io/
>>>> This is the home page of the CF Conventions web site. For the Trac
>>>> system, click on "CF Metadata Trac" in the "Quick Links" list.
>>>>
>>>> In the near future the best url for the CF Conventions web site will be
>>>> http://cfconventions.org
>>>> but it doesn't redirect to the right address yet. Andrew Harwood is
>>>> trying to get that fixed, and has run into the kind of delays which are
>>>> familiar to any of us who work for large organizations.
>>>>
>>>> Actually, the old url http://cf-pcmdi.llnl.gov is back up too. All that
>>>> one does is to give you an opportunity to "click here" to visit the github
>>>> site.
>>>>
>>>> Back to Trac, your old login will still work if you had one. The old
>>>> system for getting an account there was to email me. That still works :-)
>>>> (Presently the other people who can add accounts are Tony Hoang, Renata
>>>> McCoy, and Karl Taylor). There never was much of anything in the Trac
>>>> system to tell you how to get an account, but there should be; I need to
>>>> figure it out.
>>>>
>>>> And thanks, John, for pointing out #4. I'll fix it.
>>>>
>>>> Now to the repositories and web site - There are three github
>>>> repositories which contain the pieces that go into the web site. I
>>>> relabeled them today in an attempt to make their purposes more clear. But
>>>> repositories by their very nature are not user-friendly. The most important
>>>> thing is that someone who only needs the web site will quickly realize that
>>>> he needs to be somewhere else. Matthew Harris and I will be working on it
>>>> some more.
>>>>
>>>> But the web site isn't fundamentally very complicated. I can't see how
>>>> throwing a lot of manpower at it will make it work better or get things done
>>>> faster. In the future what would benefit from a few more contributors would
>>>> be the CF Conventions document itself, and its cousins. That is the
>>>> secondary reason, after the general principle of openness, why the CF
>>>> Conventions sources are on github now. BTW, the CF Conventions document is
>>>> written in DocBook. Earlier this year there was a brief discussion of
>>>> alternative formats. That belongs in a different thread, though.
>>>>
>>>> Please let me know if I've neglected to respond to anything which needed
>>>> an answer from me.
>>>>
>>>> - Jeff
>>>>
>>>> On 4/16/14 11:50 AM, John Graybeal wrote:
>>>>> Let me preface my concerns again volunteering to provide mildly
>>>>> knowledgeable technical labor, if the issue is simply shortage of hours.
>>>>>
>>>>> Problems with the new Trac site:
>>>>>
>>>>> 1) Apparently there was a transition where the new site
>>>>> http://kitt.llnl.gov/trac/ is now the real site?
>>>>> - If so, I missed that announcement, sorry (or if there wasn't one,
>>>>> there needs to be one.)
>>>>> - If not, we need to clarify what gets reported where 'in the
>>>>> meantime'.
>>>>> 2)<resolved>
>>>>> 3) If the new site is the official site can we make it straightforward
>>>>> and documented how people get accounts and recover passwords?
>>>>> 4) The upper left logo error (logo missing, not a crisis) sends you back
>>>>> to the old Trac site (http://cf-pcmdi.llnl.gov/trac/). Be warned.
>>>>>
>>>>> Suggestion re the process of reporting problems:
>>>>> A) Rather than reporting all problems on one ticket, create a new ticket
>>>>> for each problem and use the component 'cf-trac-site' or 'cf-web-site' as
>>>>> appropriate. There are a large number of problems that result from reporting
>>>>> multiple problems on one issue ticket.
>>>>>
>>>>> I have some additional issues with the new site, including Rich's, but
>>>>> perhaps best to resolve the above first.
>>>>>
>>>>> John
>>>>>
>>>>> On Apr 16, 2014, at 05:49, Nan Galbraith<ngalbraith at whoi.edu> wrote:
>>>>>
>>>>>> Hi Rich -
>>>>>>
>>>>>> There's a trac ticket for problems with the new website:
>>>>>> http://kitt.llnl.gov/trac/ticket/111
>>>>>>
>>>>>> For other types of problems, not related to the site itself, I'm not
>>>>>> sure.
>>>>>>
>>>>>> Nan
>>>>>>
>>>>>> On 4/16/14 7:47 AM, Signell, Richard wrote:
>>>>>>> CF folks,
>>>>>>> Moving to github should help the community contribute and be able to
>>>>>>> fix problem with the CF documents. But I'm a little confused about
>>>>>>> what to do if we see a problem at http://cf-convention.github.io/ and
>>>>>>> we want to submit a pull request to change them.
>>>>>>>
>>>>>>> At the CF github organization (https://github.com/cf-convention) I see
>>>>>>> three repositories:
>>>>>>>
>>>>>>> 1. cf-convention.github.io
>>>>>>> which controls the github pages showing up at
>>>>>>> http://cf-convention.github.io/
>>>>>>>
>>>>>>> 2. cf-documents
>>>>>>> which contains HTML and PDF versions of the documents
>>>>>>>
>>>>>>> 3. repository-cf
>>>>>>> a git svn clone of the old PCMI SVN repository
>>>>>>>
>>>>>>> So if we see a problem with pages on http://cf-convention.github.io/,
>>>>>>> which repo are we supposed to send a pull request to?
>>>>>>>
>>>>>>> Thanks,
>>>>>>> Rich
>>>>>>>
>>>>>> --
>>>>>> *******************************************************
>>>>>> * Nan Galbraith Information Systems Specialist *
>>>>>> * Upper Ocean Processes Group Mail Stop 29 *
>>>>>> * Woods Hole Oceanographic Institution *
>>>>>> * Woods Hole, MA 02543 (508) 289-2444 *
>>>>>> *******************************************************
>>>>>>
>>>>>>
>>>>>> _______________________________________________
>>>>>> CF-metadata mailing list
>>>>>> CF-metadata at cgd.ucar.edu
>>>>>> http://mailman.cgd.ucar.edu/mailman/listinfo/cf-metadata
>>>>> ------------------------------------
>>>>> John Graybeal
>>>>> Marine Data Manager
>>>>>
>>>>> M +1 408 675-5445
>>>>> skype: graybealski
>>>>> Marinexplore
>>>>> 920 Stewart Drive
>>>>> Sunnyvale 94085
>>>>> California, USA
>>>>> www.marinexplore.com
>>>>>
>>>>> _______________________________________________
>>>>> CF-metadata mailing list
>>>>> CF-metadata at cgd.ucar.edu
>>>>> http://mailman.cgd.ucar.edu/mailman/listinfo/cf-metadata
>>>> _______________________________________________
>>>> CF-metadata mailing list
>>>> CF-metadata at cgd.ucar.edu
>>>> http://mailman.cgd.ucar.edu/mailman/listinfo/cf-metadata
>>> ------------------------------------
>>> John Graybeal
>>> Marine Data Manager
>>>
>>> M +1 408 675-5445
>>> skype: graybealski
>>> Marinexplore
>>> 920 Stewart Drive
>>> Sunnyvale 94085
>>> California, USA
>>> www.marinexplore.com
>>>
>> _______________________________________________
>> CF-metadata mailing list
>> CF-metadata at cgd.ucar.edu
>> http://mailman.cgd.ucar.edu/mailman/listinfo/cf-metadata
>
>
Received on Thu Apr 17 2014 - 10:57:01 BST

This archive was generated by hypermail 2.3.0 : Tue Sep 13 2022 - 23:02:42 BST

⇐ ⇒